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

     1  ---
     2  summary: Update a release
     3  description: Update an existing release.
     4  operationId: release/update
     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  - "$ref": "../../parameters.yaml#/id"
    12  responses:
    13    '200':
    14      description: OK
    15      content:
    16        application/json:
    17          schema:
    18            "$ref": "../../schemas/release.yaml#/release"
    19      headers:
    20        X-Rate-Limit-Limit:
    21          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    22        X-Rate-Limit-Remaining:
    23          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    24        X-Rate-Limit-Reset:
    25          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    26    '400':
    27      "$ref": "../../responses.yaml#/400"
    28    '404':
    29      "$ref": "../../responses.yaml#/404"
    30    '429':
    31      "$ref": "../../responses.yaml#/429"
    32  x-code-samples:
    33  - lang: Curl
    34    source: |-
    35      curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/releases/:id" \
    36        -u USERNAME_OR_ACCESS_TOKEN \
    37        -X PATCH \
    38        -d '{"description":"My first Release","platforms":["android","ios"],"branch":"my-feature-branch"}' \
    39        -H 'Content-Type: application/json'
    40  - lang: CLI v2
    41    source: |-
    42      phrase releases update \
    43      --account_id <account_id> \
    44      --distribution_id <distribution_id> \
    45      --id <id> \
    46      --data '{"description": "My first Release", "platforms": "android,ios", "branch":"my-feature-branch"}' \
    47      --access_token <token>
    48  requestBody:
    49    required: true
    50    content:
    51      application/json:
    52        schema:
    53          type: object
    54          title: release/update/parameters
    55          properties:
    56            description:
    57              description: Description of the release
    58              type: string
    59              example: My first Release
    60            platforms:
    61              description: List of platforms the release should support.
    62              type: array
    63              items:
    64                type: string
    65              example:
    66              - android
    67              - ios
    68            branch:
    69              description: Branch used for release
    70              type: string
    71              example: my-feature-branch
    72  x-cli-version: '2.5'