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

     1  ---
     2  summary: Get Project Report
     3  description: Get report of a single project.
     4  operationId: report/show
     5  tags:
     6    - Reports
     7  parameters:
     8    - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9    - "$ref": "../../parameters.yaml#/project_id"
    10    - description: specify the branch to use
    11      example: my-feature-branch
    12      name: branch
    13      in: query
    14      schema:
    15        type: string
    16  responses:
    17    "200":
    18      description: OK
    19      content:
    20        application/json:
    21          schema:
    22            "$ref": "../../schemas/project_report.yaml#/project_report"
    23      headers:
    24        X-Rate-Limit-Limit:
    25          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    26        X-Rate-Limit-Remaining:
    27          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    28        X-Rate-Limit-Reset:
    29          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    30        Link:
    31          "$ref": "../../headers.yaml#/Link"
    32    "400":
    33      "$ref": "../../responses.yaml#/400"
    34    "404":
    35      "$ref": "../../responses.yaml#/404"
    36    "429":
    37      "$ref": "../../responses.yaml#/429"
    38  x-code-samples:
    39    - lang: Curl
    40      source: |-
    41        curl "https://api.phrase.com/v2/projects/:project_id/report?branch=my-feature-branch" \
    42          -X GET \
    43          -u USERNAME_OR_ACCESS_TOKEN
    44    - lang: CLI v2
    45      source: |-
    46        phrase report show \
    47        --project_id <project_id> \
    48        --branch my-feature-branch \
    49        --access_token <token>
    50  x-cli-version: "2.13"