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

     1  ---
     2  summary: Export to code repository
     3  description: |-
     4    > Beta: this feature will change in the future.
     5  
     6    Export translations from Phrase Strings to repository provider according to the
     7    .phrase.yml file within the code repository.
     8  
     9    *Export is done asynchronously and may take several seconds depending on the project size.*
    10  operationId: repo_sync/export
    11  tags:
    12  - Repo Syncs
    13  parameters:
    14  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
    15  - "$ref": "../../parameters.yaml#/account_id"
    16  - "$ref": "../../parameters.yaml#/repo_sync_id"
    17  responses:
    18    '200':
    19      description: OK
    20      content:
    21        application/json:
    22          schema:
    23            type: object
    24            title: repo_sync/export
    25            properties:
    26              message:
    27                type: string
    28                example: Export started
    29      headers:
    30        X-Rate-Limit-Limit:
    31          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    32        X-Rate-Limit-Remaining:
    33          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    34        X-Rate-Limit-Reset:
    35          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    36    '400':
    37      "$ref": "../../responses.yaml#/400"
    38    '404':
    39      "$ref": "../../responses.yaml#/404"
    40    '429':
    41      "$ref": "../../responses.yaml#/429"
    42  x-code-samples:
    43  - lang: Curl
    44    source: |-
    45      curl "https://api.phrase.com/v2/accounts/ab12cd34/repo_syncs/45ef6789/export"\
    46        -u USERNAME_OR_ACCESS_TOKEN \
    47        -X POST \
    48        -H 'Content-Type: application/json'
    49  - lang: CLI v2
    50    source: |-
    51      phrase repo_sync export \
    52      --repo_sync_id <repo_sync_id> \
    53      --access_token <token>
    54  x-cli-version: '2.24'