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

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