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

     1  ---
     2  summary: List style guides
     3  description: List all styleguides for the given project.
     4  operationId: styleguides/list
     5  tags:
     6  - Style guides
     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  responses:
    13    '200':
    14      description: OK
    15      content:
    16        application/json:
    17          schema:
    18            type: array
    19            items:
    20              "$ref": "../../schemas/styleguide.yaml#/styleguide"
    21      headers:
    22        X-Rate-Limit-Limit:
    23          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    24        X-Rate-Limit-Remaining:
    25          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    26        X-Rate-Limit-Reset:
    27          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    28        Link:
    29          "$ref": "../../headers.yaml#/Link"
    30        Pagination:
    31          "$ref": "../../headers.yaml#/Pagination"
    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/styleguides" \
    42        -u USERNAME_OR_ACCESS_TOKEN
    43  - lang: CLI v2
    44    source: |-
    45      phrase styleguides list \
    46      --project_id <project_id> \
    47      --access_token <token>
    48  x-cli-version: '2.5'