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

     1  ---
     2  summary: Compare branches
     3  description: 'Compare branch with main branch. <br><br><i>Note: Comparing a branch may take several minutes depending on the project size.</i>'
     4  operationId: branch/compare
     5  tags:
     6  - Branches
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/name"
    11  - description: Name of the branch
    12    example: my-branch
    13    name: name
    14    in: query
    15    schema:
    16      type: string
    17  responses:
    18    '200':
    19      description: OK
    20      headers:
    21        X-Rate-Limit-Limit:
    22          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    23        X-Rate-Limit-Remaining:
    24          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    25        X-Rate-Limit-Reset:
    26          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    27    '400':
    28      "$ref": "../../responses.yaml#/400"
    29    '404':
    30      "$ref": "../../responses.yaml#/404"
    31    '429':
    32      "$ref": "../../responses.yaml#/429"
    33  x-code-samples:
    34  - lang: Curl
    35    source: |-
    36      curl "https://api.phrase.com/v2/projects/:project_id/branches/:name/compare?name=my-branch" \
    37        -u USERNAME_OR_ACCESS_TOKEN
    38  - lang: CLI v2
    39    source: |-
    40      phrase branches compare \
    41      --project_id <project_id> \
    42      --name <name> \
    43      --name my-branch \
    44      --access_token <token>
    45  x-cli-version: '2.5'