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

     1  ---
     2  summary: Update a style guide
     3  description: Update an existing style guide.
     4  operationId: styleguide/update
     5  tags:
     6  - Style guides
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/id"
    11  responses:
    12    '200':
    13      description: OK
    14      content:
    15        application/json:
    16          schema:
    17            "$ref": "../../schemas/styleguide_details.yaml#/styleguide_details"
    18      headers:
    19        X-Rate-Limit-Limit:
    20          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    21        X-Rate-Limit-Remaining:
    22          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    23        X-Rate-Limit-Reset:
    24          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    25    '400':
    26      "$ref": "../../responses.yaml#/400"
    27    '404':
    28      "$ref": "../../responses.yaml#/404"
    29    '429':
    30      "$ref": "../../responses.yaml#/429"
    31  x-code-samples:
    32  - lang: Curl
    33    source: |-
    34      curl "https://api.phrase.com/v2/projects/:project_id/styleguides/:id" \
    35        -u USERNAME_OR_ACCESS_TOKEN \
    36        -X PATCH \
    37        -d '{"title":"Web application style guide","audience":"customer-facing","target_audience":"teenager","grammatical_person":"first_person_singular","vocabulary_type":"technical","business":"We are a travel site that helps customers find the best hotels and flights.","company_branding":"ACME Inc. should never be translated.","formatting":"Never use capital letters","glossary_terms":"Apartment, cabin, loft","grammar_consistency":","literal_translation":"Neutral","overall_tone":"Tone should be fun and light","samples":"http://www.myexample.com/my/document/path/to/samples.pdf"}' \
    38        -H 'Content-Type: application/json'
    39  - lang: CLI v2
    40    source: |-
    41      phrase styleguides update \
    42      --project_id <project_id> \
    43      --id <id> \
    44      --data '{"title": "Web application style guide", "audience":"customer-facing", "target_audience":"teenager", "grammatical_person":"first_person_singular", "vocabulary_type":"technical", "business": "We are a travel site that helps customers find the best hotels and flights.", "company_branding": "ACME Inc. should never be translated.", "formatting": "Never use capital letters", "glossary_terms": "Apartment, cabin, loft", "grammar_consistency":", "literal_translation":"Neutral", "overall_tone": "Tone should be fun and light", "samples": "http://www.myexample.com/my/document/path/to/samples.pdf"}' \
    45      --access_token <token>
    46  requestBody:
    47    required: true
    48    content:
    49      application/json:
    50        schema:
    51          type: object
    52          title: styleguide/update/parameters
    53          properties:
    54            title:
    55              description: Style guide title
    56              type: string
    57              example: Web application style guide
    58            audience:
    59              description: Audience description
    60              type: string
    61              example: customer-facing
    62            target_audience:
    63              description: 'Can be one of: not_specified, children, teenager, young_adults, adults, old_adults.'
    64              type: string
    65              example: teenager
    66            grammatical_person:
    67              description: 'Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural.'
    68              type: string
    69              example: first_person_singular
    70            vocabulary_type:
    71              description: 'Can be one of: not_specified, popular, technical, fictional.'
    72              type: string
    73              example: technical
    74            business:
    75              description: Description of the business
    76              type: string
    77              example: We are a travel site that helps customers find the best hotels and flights.
    78            company_branding:
    79              description: Company branding to remain consistent.
    80              type: string
    81              example: ACME Inc. should never be translated.
    82            formatting:
    83              description: Formatting requirements and character limitations.
    84              type: string
    85              example: Never use capital letters
    86            glossary_terms:
    87              description: List of terms and/or phrases that need to be translated consistently.
    88              type: string
    89              example: Apartment, cabin, loft
    90            grammar_consistency:
    91              description: Formal or informal pronouns, consistent conjugation, grammatical gender
    92              type: string
    93              example: ''
    94            literal_translation:
    95              description: 'Can be one of: Cultural/Conversational, Literal, Neutral.'
    96              type: string
    97              example: Neutral
    98            overall_tone:
    99              description: Tone requirement descriptions
   100              type: string
   101              example: Tone should be fun and light
   102            samples:
   103              description: Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency.
   104              type: string
   105              example: http://www.myexample.com/my/document/path/to/samples.pdf
   106  x-cli-version: '2.5'