ReleaseIn

Fields

13 fields

baseline_release_id

string or null

cutoff_end_at

string (date-time) or null

cutoff_start_at

string (date-time) or null

description

string or null

name · required

string

owner_user_id

string or null

phases

array of PhaseIn

planned_date

string (date-time) or null

project_id · required

string

release_type

string or null

status

string

target_environment

string or null

version

string or null

Raw schema (JSON)

{
  "properties": {
    "baseline_release_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Baseline Release Id"
    },
    "cutoff_end_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cutoff End At"
    },
    "cutoff_start_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cutoff Start At"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "owner_user_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Owner User Id"
    },
    "phases": {
      "default": [],
      "items": {
        "$ref": "#/components/schemas/PhaseIn"
      },
      "title": "Phases",
      "type": "array"
    },
    "planned_date": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Planned Date"
    },
    "project_id": {
      "title": "Project Id",
      "type": "string"
    },
    "release_type": {
      "anyOf": [
        {
          "enum": [
            "major",
            "minor",
            "patch",
            "hotfix",
            "rc"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Release Type"
    },
    "status": {
      "default": "planning",
      "title": "Status",
      "type": "string"
    },
    "target_environment": {
      "anyOf": [
        {
          "maxLength": 100,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Target Environment"
    },
    "version": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Version"
    }
  },
  "required": [
    "project_id",
    "name"
  ],
  "title": "ReleaseIn",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/releases — Create Release

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON