github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/reports/locales/index.yaml (about)

     1  ---
     2  summary: List Locale Reports
     3  description: List all locale reports for the given project
     4  operationId: report/locales/list
     5  tags:
     6    - Reports
     7  parameters:
     8    - "$ref": "../../../parameters.yaml#/X-PhraseApp-OTP"
     9    - "$ref": "../../../parameters.yaml#/project_id"
    10    - "$ref": "../../../parameters.yaml#/page"
    11    - "$ref": "../../../parameters.yaml#/per_page"
    12    - "$ref": "../../../parameters.yaml#/locale_codes"
    13    - "$ref": "../../../parameters.yaml#/tag"
    14    - description: specify the branch to use
    15      example: my-feature-branch
    16      name: branch
    17      in: query
    18      schema:
    19        type: string
    20  responses:
    21    "200":
    22      description: OK
    23      content:
    24        application/json:
    25          schema:
    26            type: array
    27            items:
    28              "$ref": "../../../schemas/locale_report.yaml#/locale_report"
    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        Link:
    37          "$ref": "../../../headers.yaml#/Link"
    38    "400":
    39      "$ref": "../../../responses.yaml#/400"
    40    "404":
    41      "$ref": "../../../responses.yaml#/404"
    42    "429":
    43      "$ref": "../../../responses.yaml#/429"
    44  x-code-samples:
    45    - lang: Curl
    46      source: |-
    47        curl "https://api.phrase.com/v2/projects/:project_id/report/locales?locale_codes[]=de&locale_codes[]=en&branch=my-feature-branch" \
    48          -X GET \
    49          -u USERNAME_OR_ACCESS_TOKEN
    50    - lang: CLI v2
    51      source: |-
    52        phrase report locales list \
    53        --project_id <project_id> \
    54        --branch my-feature-branch \
    55        --locale_codes de \
    56        --access_token <token>
    57  x-cli-version: "2.13"