github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/styleguides/create.yaml (about) 1 --- 2 summary: Create a style guide 3 description: Create a new style guide. 4 operationId: styleguide/create 5 tags: 6 - Style guides 7 parameters: 8 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP" 9 - "$ref": "../../parameters.yaml#/project_id" 10 responses: 11 '201': 12 description: Created 13 content: 14 application/json: 15 schema: 16 "$ref": "../../schemas/styleguide_details.yaml#/styleguide_details" 17 headers: 18 X-Rate-Limit-Limit: 19 "$ref": "../../headers.yaml#/X-Rate-Limit-Limit" 20 X-Rate-Limit-Remaining: 21 "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining" 22 X-Rate-Limit-Reset: 23 "$ref": "../../headers.yaml#/X-Rate-Limit-Reset" 24 '400': 25 "$ref": "../../responses.yaml#/400" 26 '404': 27 "$ref": "../../responses.yaml#/404" 28 '429': 29 "$ref": "../../responses.yaml#/429" 30 x-code-samples: 31 - lang: Curl 32 source: |- 33 curl "https://api.phrase.com/v2/projects/:project_id/styleguides" \ 34 -u USERNAME_OR_ACCESS_TOKEN \ 35 -X POST \ 36 -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"}' \ 37 -H 'Content-Type: application/json' 38 - lang: CLI v2 39 source: |- 40 phrase styleguides create \ 41 --project_id <project_id> \ 42 --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"}' \ 43 --access_token <token> 44 requestBody: 45 required: true 46 content: 47 application/json: 48 schema: 49 type: object 50 title: styleguide/create/parameters 51 required: 52 - title 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'