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

     1  ---
     2  summary: Export from Phrase Strings to GitLab
     3  description: 'Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository. <br><br><i>Note: Export is done asynchronously and may take several seconds depending on the project size.</i>'
     4  operationId: gitlab_sync/export
     5  tags:
     6  - GitLab Sync
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/gitlab_sync_id"
    10  responses:
    11    '200':
    12      description: OK
    13      content:
    14        application/json:
    15          schema:
    16            "$ref": "../../schemas/gitlab_sync_export.yaml#/gitlab_sync_export"
    17      headers:
    18        X-Rate-Limit-Limit:
    19          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    20        X-Rate-Limit-Remaining:
    21          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    22        X-Rate-Limit-Reset:
    23          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    24    '400':
    25      "$ref": "../../responses.yaml#/400"
    26    '404':
    27      "$ref": "../../responses.yaml#/404"
    28    '429':
    29      "$ref": "../../responses.yaml#/429"
    30  x-code-samples:
    31  - lang: Curl
    32    source: |-
    33      curl "https://api.phrase.com/v2/gitlab_syncs/:gitlab_sync_id/export" \
    34        -u USERNAME_OR_ACCESS_TOKEN \
    35        -X POST \
    36        -d '{"account_id":"abcd1234"}' \
    37        -H 'Content-Type: application/json'
    38  - lang: CLI v2
    39    source: |-
    40      phrase git_lab_sync export \
    41      --gitlab_sync_id <gitlab_sync_id> \
    42      --data '{"account_id":"abcd1234"}' \
    43      --access_token <token>
    44  requestBody:
    45    required: true
    46    content:
    47      application/json:
    48        schema:
    49          type: object
    50          title: gitlab_sync/export/parameters
    51          properties:
    52            account_id:
    53              description: Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
    54              type: string
    55              example: abcd1234
    56  x-cli-version: '2.5'