github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/main.yaml (about) 1 openapi: 3.0.3 2 3 info: 4 title: Phrase Strings API Reference 5 version: 2.0.0 6 description: 7 $ref: "./intro.md" 8 9 contact: 10 name: Phrase Support 11 url: https://developers.phrase.com/api/ 12 email: support@phrase.com 13 14 x-logo: 15 url: "https://developers.phrase.com/images/phrase-logo.svg" 16 backgroundColor: "#03eab3" 17 altText: "Phrase Strings" 18 19 termsOfService: "https://phrase.com/terms/" 20 21 license: 22 name: MIT 23 url: https://choosealicense.com/licenses/mit/ 24 25 servers: 26 - url: https://api.phrase.com/v2 27 28 security: 29 - Token: [] 30 - Basic: [] 31 32 tags: 33 - name: Accounts 34 - name: Authorizations 35 description: | 36 The endpoints provided by the Authorizations API are **only accessible via Basic authentication with email and password**. 37 38 When creating a new authorization, the new access token for this authorization will be returned in the immediate response but not later, due to security reasons. When accessing authorizations later, you will only see the last eight chars of the token in plain text (`token_last_eight`) and the SHA256 digest of the token for reference (`hashed_token`). 39 40 For instructions on how authorization in general works, see our [Auth Guide](#overview--authentication). 41 42 ### Scopes 43 44 When creating or updating an OAuth authorization, you can define a list of scopes to limit the access that can be performed by that authorization. 45 46 #### Available Scopes 47 48 <div class="table-responsive"> 49 <table class="basic-table"> 50 <thead> 51 <tr class="basic-table__row basic-table__row--header"> 52 <th class="basic-table__cell basic-table__cell--header">Scope</th> 53 <th class="basic-table__cell basic-table__cell--header">Description</th> 54 </tr> 55 </thead> 56 <tbody> 57 <tr> 58 <td class="basic-table__cell"><code>read</code></td> 59 <td class="basic-table__cell">Read projects, locales, keys, translations, orders</td> 60 </tr> 61 <tr> 62 <td class="basic-table__cell"><code>write</code></td> 63 <td class="basic-table__cell">Write projects, locales, keys, translations but not orders</td> 64 </tr> 65 <tr> 66 <td class="basic-table__cell"><code>orders.create</code></td> 67 <td class="basic-table__cell">Create and confirm orders</td> 68 </tr> 69 <tr> 70 <td class="basic-table__cell"><code>team.manage</code></td> 71 <td class="basic-table__cell">Manage invitations and members</td> 72 </tr> 73 </tbody> 74 </table> 75 </div> 76 - name: Bitbucket Sync 77 - name: Blacklisted Keys 78 - name: Branches 79 description: | 80 ### Branch creation 81 82 Branches will be created asynchronously. State of branch creation is returned as state. 83 84 #### Available States 85 86 <div class="table-responsive"> 87 <table class="basic-table"> 88 <thead> 89 <tr class="basic-table__row basic-table__row--header"> 90 <th class="basic-table__cell basic-table__cell--header">State</th> 91 <th class="basic-table__cell basic-table__cell--header">Description</th> 92 </tr> 93 </thead> 94 <tbody> 95 <tr> 96 <td class="basic-table__cell"><code>initialized</code></td> 97 <td class="basic-table__cell">Data received.</td> 98 </tr> 99 <tr> 100 <td class="basic-table__cell"><code>processing</code></td> 101 <td class="basic-table__cell">Branch is currently creating.</td> 102 </tr> 103 <tr> 104 <td class="basic-table__cell"><code>success</code></td> 105 <td class="basic-table__cell">Branch was created successfully</td> 106 </tr> 107 <tr> 108 <td class="basic-table__cell"><code>error</code></td> 109 <td class="basic-table__cell">Branch creation failed.</td> 110 </tr> 111 </tbody> 112 </table> 113 </div> 114 - name: Comments 115 - name: Comment Reactions 116 - name: Comment Replies 117 - name: Custom Metadata 118 - name: Distributions 119 - name: Documents 120 - name: Figma Attachments 121 - name: Formats 122 - name: GitHub Sync 123 - name: GitLab Sync 124 - name: Glossaries 125 - name: Glossary Terms 126 - name: Glossary Term Translations 127 - name: ICU 128 - name: Invitations 129 description: | 130 With the invitation endpoint you can [manage and invite users](https://support.phrase.com/hc/en-us/articles/5709742418716) to Phrase Strings via API. A user can have the role Manager, Developer or Translator each with its own access rights. Developers and translators need resources like projects and locales assigned in order to access them. 131 - name: Job Comments 132 - name: Job Locales 133 - name: Job Template Locales 134 - name: Job Templates 135 - name: Jobs 136 - name: Keys 137 - name: Locales 138 - name: Members 139 description: | 140 With the members endpoints you can do basic [team and user management](https://support.phrase.com/hc/en-us/articles/5709742418716) via API. A user can have the role Manager, Developer or Translator each with its own access rights. Developers and translators need resources like projects and locales assigned in order to access them. 141 - name: Notifications 142 - name: Notification Groups 143 - name: Orders 144 description: | 145 ### List of categories [TextMaster] 146 147 When ordering translations from TextMaster, you need to specify a category ID along with your order. See this list for information on the category ID and their equivalent description. 148 149 <div class="table-responsive"> 150 <table class="basic-table"> 151 <thead> 152 <tr class="basic-table__row basic-table__row--header"> 153 <th class="basic-table__cell basic-table__cell--header">Category ID</th> 154 <th class="basic-table__cell basic-table__cell--header">Description</th> 155 </tr> 156 </thead> 157 <tbody> 158 <tr><td class="basic-table__cell">C001</td><td class="basic-table__cell">Agriculture</td></tr> 159 <tr><td class="basic-table__cell">C002</td><td class="basic-table__cell">Aerospace</td></tr> 160 <tr><td class="basic-table__cell">C003</td><td class="basic-table__cell">Animals/Pets/Plants</td></tr> 161 <tr><td class="basic-table__cell">C004</td><td class="basic-table__cell">Arts/Culture/Literature</td></tr> 162 <tr><td class="basic-table__cell">C005</td><td class="basic-table__cell">Automotive/Transportation</td></tr> 163 <tr><td class="basic-table__cell">C006</td><td class="basic-table__cell">Computers/Technology/Software</td></tr> 164 <tr><td class="basic-table__cell">C007</td><td class="basic-table__cell">Telecom</td></tr> 165 <tr><td class="basic-table__cell">C008</td><td class="basic-table__cell">Real Estate/Construction/Building</td></tr> 166 <tr><td class="basic-table__cell">C009</td><td class="basic-table__cell">Consumer Goods</td></tr> 167 <tr><td class="basic-table__cell">C010</td><td class="basic-table__cell">Education</td></tr> 168 <tr><td class="basic-table__cell">C011</td><td class="basic-table__cell">Entertainment</td></tr> 169 <tr><td class="basic-table__cell">C012</td><td class="basic-table__cell">Ecology/Environment</td></tr> 170 <tr><td class="basic-table__cell">C013</td><td class="basic-table__cell">Health/Biotechnology/Pharma</td></tr> 171 <tr><td class="basic-table__cell">C014</td><td class="basic-table__cell">Internet</td></tr> 172 <tr><td class="basic-table__cell">C015</td><td class="basic-table__cell">Policy/Government/Public</td></tr> 173 <tr><td class="basic-table__cell">C016</td><td class="basic-table__cell">Publishing/Media/Communication</td></tr> 174 <tr><td class="basic-table__cell">C017</td><td class="basic-table__cell">Religion</td></tr> 175 <tr><td class="basic-table__cell">C018</td><td class="basic-table__cell">Food/Beverages</td></tr> 176 <tr><td class="basic-table__cell">C019</td><td class="basic-table__cell">Retail</td></tr> 177 <tr><td class="basic-table__cell">C020</td><td class="basic-table__cell">Fashion/Luxury/Textiles</td></tr> 178 <tr><td class="basic-table__cell">C021</td><td class="basic-table__cell">Travel/Tourism</td></tr> 179 <tr><td class="basic-table__cell">C022</td><td class="basic-table__cell">Natural Resources/Energy</td></tr> 180 <tr><td class="basic-table__cell">C023</td><td class="basic-table__cell">Banking/Financial Services/Insurance</td></tr> 181 <tr><td class="basic-table__cell">C024</td><td class="basic-table__cell">Legal Affairs/Tax/Law</td></tr> 182 <tr><td class="basic-table__cell">C025</td><td class="basic-table__cell">Raw Materials/Industrial Goods</td></tr> 183 <tr><td class="basic-table__cell">C026</td><td class="basic-table__cell">Lifestyle/Leisure/Hobbies</td></tr> 184 <tr><td class="basic-table__cell">C027</td><td class="basic-table__cell">Sports</td></tr> 185 <tr><td class="basic-table__cell">C028</td><td class="basic-table__cell">Home/Family/Friends/Children</td></tr> 186 <tr><td class="basic-table__cell">C029</td><td class="basic-table__cell">Economy/Financial Markets</td></tr> 187 <tr><td class="basic-table__cell">C030</td><td class="basic-table__cell">Science</td></tr> 188 <tr><td class="basic-table__cell">C031</td><td class="basic-table__cell">Human Resources/Employment</td></tr> 189 <tr><td class="basic-table__cell">C032</td><td class="basic-table__cell">Adult (Pornography, Violence, etc.)</td></tr> 190 </tbody> 191 </table> 192 </div> 193 - name: Organization Job Template Locales 194 - name: Organization Job Templates 195 - name: Projects 196 - name: Quality 197 - name: Releases 198 - name: Repo Syncs 199 description: | 200 The Repo Syncs API allows you to synchronize your Phrase projects with your code repositories. 201 You can import translations from your repository to Phrase and export translations from Phrase to your repository. 202 - name: Reports 203 - name: Search 204 - name: Screenshot Markers 205 - name: Screenshots 206 - name: Spaces 207 - name: Style guides 208 - name: Tags 209 - name: Teams 210 - name: Translations 211 - name: Uploads 212 description: | 213 ### Formats 214 215 We support all common localization file formats. For a detailed overview, see our [Format Guide](https://support.phrase.com/hc/en-us/sections/6111343326364). 216 217 ### Processing 218 219 Uploads will be processed asynchronously and thus the data might not be imported yet although the upload is completed. Therefore we recommend to evaluate the returned <code>state</code> field for information on the import progress. 220 221 #### Available States 222 223 <div class="table-responsive"> 224 <table class="basic-table"> 225 <thead> 226 <tr class="basic-table__row basic-table__row--header"> 227 <th class="basic-table__cell basic-table__cell--header">State</th> 228 <th class="basic-table__cell basic-table__cell--header">Description</th> 229 </tr> 230 </thead> 231 <tbody> 232 <tr> 233 <td class="basic-table__cell"><code>initialized</code></td> 234 <td class="basic-table__cell">Data received.</td> 235 </tr> 236 <tr> 237 <td class="basic-table__cell"><code>waiting_for_preview</code></td> 238 <td class="basic-table__cell">Upload is waiting for preview to be finished.</td> 239 </tr> 240 <tr> 241 <td class="basic-table__cell"><code>waiting</code></td> 242 <td class="basic-table__cell">Upload is waiting for processing.</td> 243 </tr> 244 <tr> 245 <td class="basic-table__cell"><code>processing</code></td> 246 <td class="basic-table__cell">Upload is being processed, data is currently imported.</td> 247 </tr> 248 <tr> 249 <td class="basic-table__cell"><code>success</code></td> 250 <td class="basic-table__cell">Upload is complete and all data is imported.</td> 251 </tr> 252 <tr> 253 <td class="basic-table__cell"><code>error</code></td> 254 <td class="basic-table__cell">Upload or import process failed.</td> 255 </tr> 256 </tbody> 257 </table> 258 </div> 259 - name: Users 260 - name: Variables 261 - name: Versions / History 262 - name: Webhooks 263 - name: Webhook Deliveries 264 265 x-tagGroups: 266 - name: Core Resources 267 tags: 268 - Projects 269 - Locales 270 - Keys 271 - Translations 272 - Uploads 273 - Tags 274 - Custom Metadata Properties 275 - Blacklisted Keys 276 - Versions / History 277 - name: Workflows 278 tags: 279 - Spaces 280 - Jobs 281 - Job Comments 282 - Job Locales 283 - Job Templates 284 - Job Template Locales 285 - Organization Job Templates 286 - Organization Job Template Locales 287 - Comments 288 - Comment Reactions 289 - Comment Replies 290 - Branches 291 - name: Quality 292 tags: 293 - Glossaries 294 - Glossary Terms 295 - Glossary Term Translations 296 - name: Integrations 297 tags: 298 - Bitbucket Sync 299 - GitHub Sync 300 - GitLab Sync 301 - Webhooks 302 - Distributions 303 - Releases 304 - name: Ordering 305 tags: 306 - Orders 307 - Style guides 308 - name: User management 309 tags: 310 - Authorizations 311 - Users 312 - Accounts 313 - Members 314 - Invitations 315 - name: Screenshots 316 tags: 317 - Screenshots 318 - Screenshot Markers 319 - name: Misc 320 tags: 321 - Formats 322 - name: Figma Attachments 323 tags: 324 - Figma attachments 325 - Key's Figma attachments 326 327 components: 328 securitySchemes: 329 Token: 330 type: apiKey 331 in: header 332 name: Authorization 333 description: Enter your token in the format `token TOKEN` 334 Basic: 335 type: http 336 scheme: basic 337 338 headers: 339 $ref: "./headers.yaml" 340 341 schemas: 342 $ref: "./schemas.yaml#/schemas" 343 344 parameters: 345 $ref: "./parameters.yaml" 346 347 responses: 348 $ref: "./responses.yaml" 349 350 paths: 351 $ref: "./paths.yaml"