Skip to content

Commit 83a2ab8

Browse files
Merge pull request #8030 from camunda/45404-update-authorization-api-docs-missing-400-response
Adding 400 response for authorization update
2 parents e193184 + 1ed68aa commit 83a2ab8

File tree

2 files changed

+99
-1
lines changed

2 files changed

+99
-1
lines changed

docs/apis-tools/orchestration-cluster-api-rest/specifications/update-authorization.api.mdx

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Update the authorization with the given key.
4949
name: "authorizationKey",
5050
in: "path",
5151
required: true,
52-
description: "The key of the authorization to delete.",
52+
description: "The key of the authorization to update.",
5353
schema: {
5454
allOf: [
5555
{
@@ -338,6 +338,55 @@ Update the authorization with the given key.
338338
label={undefined}
339339
responses={{
340340
"204": { description: "The authorization was updated successfully." },
341+
"400": {
342+
description: "The authorization update request is invalid.",
343+
headers: { "WWW-Authenticate": { schema: { type: "string" } } },
344+
content: {
345+
"application/problem+json": {
346+
schema: {
347+
description:
348+
"A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). There may be additional properties specific to the problem type.\n",
349+
type: "object",
350+
properties: {
351+
type: {
352+
type: "string",
353+
format: "uri",
354+
description: "A URI identifying the problem type.",
355+
default: "about:blank",
356+
example: "about:blank",
357+
},
358+
title: {
359+
type: "string",
360+
description: "A summary of the problem type.",
361+
example: "Bad Request",
362+
},
363+
status: {
364+
type: "integer",
365+
format: "int32",
366+
description: "The HTTP status code for this problem.",
367+
example: 400,
368+
minimum: 400,
369+
maximum: 600,
370+
},
371+
detail: {
372+
type: "string",
373+
description: "An explanation of the problem in more detail.",
374+
example:
375+
"At least one of [resourceId, resourcePropertyName] is required",
376+
},
377+
instance: {
378+
type: "string",
379+
format: "uri",
380+
description:
381+
"A URI path identifying the origin of the problem.",
382+
example: "/v2/authorizations/2251799813685318",
383+
},
384+
},
385+
title: "ProblemDetail",
386+
},
387+
},
388+
},
389+
},
341390
"401": {
342391
description: "The request lacks valid authentication credentials.",
343392
headers: { "WWW-Authenticate": { schema: { type: "string" } } },

versioned_docs/version-8.8/apis-tools/orchestration-cluster-api-rest/specifications/update-authorization.api.mdx

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,55 @@ Update the authorization with the given key.
188188
label={undefined}
189189
responses={{
190190
"204": { description: "The authorization was updated successfully." },
191+
"400": {
192+
description: "The authorization update request is invalid.",
193+
headers: { "WWW-Authenticate": { schema: { type: "string" } } },
194+
content: {
195+
"application/problem+json": {
196+
schema: {
197+
description:
198+
"A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). There may be additional properties specific to the problem type.\n",
199+
type: "object",
200+
properties: {
201+
type: {
202+
type: "string",
203+
format: "uri",
204+
description: "A URI identifying the problem type.",
205+
default: "about:blank",
206+
example: "about:blank",
207+
},
208+
title: {
209+
type: "string",
210+
description: "A summary of the problem type.",
211+
example: "Bad Request",
212+
},
213+
status: {
214+
type: "integer",
215+
format: "int32",
216+
description: "The HTTP status code for this problem.",
217+
example: 400,
218+
minimum: 400,
219+
maximum: 600,
220+
},
221+
detail: {
222+
type: "string",
223+
description: "An explanation of the problem in more detail.",
224+
example:
225+
"At least one of [resourceId, resourcePropertyName] is required",
226+
},
227+
instance: {
228+
type: "string",
229+
format: "uri",
230+
description:
231+
"A URI path identifying the origin of the problem.",
232+
example: "/v2/authorizations/2251799813685318",
233+
},
234+
},
235+
title: "ProblemDetail",
236+
},
237+
},
238+
},
239+
},
191240
"401": {
192241
description: "The request lacks valid authentication credentials.",
193242
headers: { "WWW-Authenticate": { schema: { type: "string" } } },

0 commit comments

Comments
 (0)