github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/jobs/update.yaml (about) 1 --- 2 summary: Update a job 3 description: Update an existing job. 4 operationId: job/update 5 tags: 6 - Jobs 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/job_details.yaml#/job_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/jobs/:id" \ 35 -u USERNAME_OR_ACCESS_TOKEN \ 36 -X PATCH \ 37 -d '{"branch":"my-feature-branch","name":"de","briefing":"de-DE","due_date":"2017-08-15","ticket_url":"https://example.atlassian.net/browse/FOO"}' \ 38 -H 'Content-Type: application/json' 39 - lang: CLI v2 40 source: |- 41 phrase jobs update \ 42 --project_id <project_id> \ 43 --id <id> \ 44 --data '{"branch":"my-feature-branch", "name":"de", "briefing":"de-DE", "due_date":"2017-08-15", "ticket_url":"https://example.atlassian.net/browse/FOO"}' \ 45 --access_token <token> 46 requestBody: 47 required: true 48 content: 49 application/json: 50 schema: 51 type: object 52 title: job/update/parameters 53 properties: 54 branch: 55 description: specify the branch to use 56 type: string 57 example: my-feature-branch 58 name: 59 description: Job name 60 type: string 61 example: de 62 briefing: 63 description: Briefing for the translators 64 type: string 65 example: de-DE 66 due_date: 67 description: Date the job should be finished 68 type: string 69 format: date-time 70 example: '2017-08-15' 71 nullable: true 72 ticket_url: 73 description: URL to a ticket for this job (e.g. Jira, Trello) 74 type: string 75 example: https://example.atlassian.net/browse/FOO 76 x-cli-version: '2.5'