{ "opencollection": "1.0.0", "info": { "name": "Phrase Strings API Reference Accounts Branches API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Branches", "type": "folder" }, "items": [ { "info": { "name": "List branches", "type": "http" }, "http": { "method": "GET", "url": "https://api.phrase.com/v2/projects/:project_id/branches", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "page", "value": "1", "type": "query", "description": "Page number" }, { "name": "per_page", "value": "25", "type": "query", "description": "Limit on the number of objects to be returned, between 1 and 100. 25 by default" } ] }, "docs": "List all branches the of the current project." }, { "info": { "name": "Create a branch", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/projects/:project_id/branches", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new branch.\n\n*Note: Creating a new branch may take several minutes depending on the project size.*\n" }, { "info": { "name": "Get a single branch", "type": "http" }, "http": { "method": "GET", "url": "https://api.phrase.com/v2/projects/:project_id/branches/:name", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "name", "value": "", "type": "path", "description": "name" } ] }, "docs": "Get details on a single branch for a given project." }, { "info": { "name": "Update a branch", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.phrase.com/v2/projects/:project_id/branches/:name", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "name", "value": "", "type": "path", "description": "name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing branch." }, { "info": { "name": "Delete a branch", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.phrase.com/v2/projects/:project_id/branches/:name", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "name", "value": "", "type": "path", "description": "name" } ] }, "docs": "Delete an existing branch." }, { "info": { "name": "Merge a branch", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.phrase.com/v2/projects/:project_id/branches/:name/merge", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "name", "value": "", "type": "path", "description": "name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Merge an existing branch.\n\n*Note: Merging a branch may take several minutes depending on diff size.*\n" }, { "info": { "name": "Sync a branch", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.phrase.com/v2/projects/:project_id/branches/:name/sync", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "name", "value": "", "type": "path", "description": "name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sync an existing branch.\n\n*Note: Only available for branches created with new branching.*\n" }, { "info": { "name": "Compare branches", "type": "http" }, "http": { "method": "GET", "url": "https://api.phrase.com/v2/projects/:project_id/branches/:name/compare", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "name", "value": "", "type": "path", "description": "name" }, { "name": "name", "value": "my-branch", "type": "query", "description": "Name of the branch" } ] }, "docs": "Compare branch with main branch.\n\n*Note: Comparing a branch may take several minutes depending on the project size. Consider using the `POST /compare` endpoint for creating comparison asynchronously.*\n" }, { "info": { "name": "Create comparison (async.)", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/projects/:project_id/branches/:name/compare", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "name", "value": "", "type": "path", "description": "name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a branch comparison asynchronously.\n" } ] } ], "bundled": true }