github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/releases/create.yaml (about)

     1  ---
     2  summary: Create a release
     3  description: Create a new release.
     4  operationId: release/create
     5  tags:
     6    - Releases
     7  parameters:
     8    - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9    - "$ref": "../../parameters.yaml#/account_id"
    10    - "$ref": "../../parameters.yaml#/distribution_id"
    11  responses:
    12    "201":
    13      description: Created
    14      content:
    15        application/json:
    16          schema:
    17            "$ref": "../../schemas/release.yaml#/release"
    18      headers:
    19        X-Rate-Limit-Limit:
    20          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    21        X-Rate-Limit-Remaining:
    22          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    23        X-Rate-Limit-Reset:
    24          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    25    "400":
    26      "$ref": "../../responses.yaml#/400"
    27    "404":
    28      "$ref": "../../responses.yaml#/404"
    29    "429":
    30      "$ref": "../../responses.yaml#/429"
    31  x-code-samples:
    32    - lang: Curl
    33      source: |-
    34        curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/releases" \
    35          -u USERNAME_OR_ACCESS_TOKEN \
    36          -X POST \
    37          -d '{"description":"My first Release","platforms":["android","ios"],"branch":"my-feature-branch"}' \
    38          -H 'Content-Type: application/json'
    39    - lang: CLI v2
    40      source: |-
    41        phrase releases create \
    42        --account_id <account_id> \
    43        --distribution_id <distribution_id> \
    44        --data '{"description": "My first Release", "platforms": ["android", "ios"], "branch":"my-feature-branch"}' \
    45        --access_token <token>
    46  requestBody:
    47    required: true
    48    content:
    49      application/json:
    50        schema:
    51          type: object
    52          title: release/create/parameters
    53          properties:
    54            description:
    55              description: Description of the release
    56              type: string
    57              example: My first Release
    58            platforms:
    59              description: List of platforms the release should support.
    60              type: array
    61              items:
    62                type: string
    63              example:
    64                - android
    65                - ios
    66            locale_ids:
    67              description: List of locale ids that will be included in the release. If empty, distribution locales will be used
    68              type: array
    69              items:
    70                type: string
    71              example:
    72                - abcd1234cdef1234abcd1234cdef1234
    73                - fff565db236400772368235db2c6117e
    74            tags:
    75              description: Only include tagged keys in the release. For a key to be included it must be tagged with all tags provided
    76              type: array
    77              items:
    78                type: string
    79              example:
    80                - android
    81                - feature1
    82            branch:
    83              description: Branch used for release
    84              type: string
    85              example: my-feature-branch
    86  x-cli-version: "2.8"