Skip to content

Commit c60cf1a

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent 241ed3b commit c60cf1a

File tree

1 file changed

+121
-109
lines changed

1 file changed

+121
-109
lines changed

‎services/auditlog/v2/auditlog.json‎

Lines changed: 121 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,14 @@
5858
}
5959
},
6060
"schema": {
61-
"$ref": "#/components/schemas/error"
61+
"$ref": "#/components/schemas/ErrorResponse"
6262
}
6363
}
6464
},
65-
"description": "Bad Request"
65+
"description": "Bad Request",
66+
"x-stackit-sdk": {
67+
"schema-name": "BadRequestResponse"
68+
}
6669
},
6770
"DownloadAuditLogEntriesResponse": {
6871
"content": {
@@ -75,7 +78,7 @@
7578
},
7679
"items": {
7780
"items": {
78-
"$ref": "#/components/schemas/auditLogEntry"
81+
"$ref": "#/components/schemas/AuditLogEntryResponse"
7982
},
8083
"type": "array"
8184
},
@@ -108,11 +111,14 @@
108111
}
109112
},
110113
"schema": {
111-
"$ref": "#/components/schemas/error"
114+
"$ref": "#/components/schemas/ErrorResponse"
112115
}
113116
}
114117
},
115-
"description": "Resource was not found"
118+
"description": "Resource was not found",
119+
"x-stackit-sdk": {
120+
"schema-name": "NotFoundResponse"
121+
}
116122
},
117123
"TooManyRequests": {
118124
"content": {
@@ -126,11 +132,14 @@
126132
}
127133
},
128134
"schema": {
129-
"$ref": "#/components/schemas/gatewayError"
135+
"$ref": "#/components/schemas/GatewayErrorResponse"
130136
}
131137
}
132138
},
133-
"description": "Too many requests"
139+
"description": "Too many requests",
140+
"x-stackit-sdk": {
141+
"schema-name": "TooManyRequestsResponse"
142+
}
134143
},
135144
"Unauthorized": {
136145
"content": {
@@ -146,18 +155,97 @@
146155
}
147156
},
148157
"schema": {
149-
"$ref": "#/components/schemas/error"
158+
"$ref": "#/components/schemas/ErrorResponse"
150159
}
151160
}
152161
},
153-
"description": "Request could not be authorized"
162+
"description": "Request could not be authorized",
163+
"x-stackit-sdk": {
164+
"schema-name": "UnauthorizedResponse"
165+
}
154166
}
155167
},
156168
"schemas": {
157-
"auditLogEntry": {
169+
"AuditLogEntryContextResponse": {
170+
"description": "Request context",
171+
"properties": {
172+
"folderId": {
173+
"description": "Folder id",
174+
"maxLength": 255,
175+
"minLength": 1,
176+
"type": "string"
177+
},
178+
"organizationId": {
179+
"description": "Organization id",
180+
"maxLength": 255,
181+
"minLength": 1,
182+
"type": "string"
183+
},
184+
"projectId": {
185+
"description": "Project id",
186+
"maxLength": 255,
187+
"minLength": 1,
188+
"type": "string"
189+
}
190+
},
191+
"type": "object"
192+
},
193+
"AuditLogEntryDetailsResponse": {
194+
"description": "Additional information about the event that is not part of the request or response. May contain arbitrary data.",
195+
"type": "object"
196+
},
197+
"AuditLogEntryInitiatorResponse": {
198+
"description": "Information about who made the request.",
199+
"properties": {
200+
"email": {
201+
"description": "E-Mail of the user or service account who triggered the request",
202+
"format": "email",
203+
"maxLength": 255,
204+
"minLength": 1,
205+
"type": "string"
206+
},
207+
"id": {
208+
"description": "Unique identifier of the user",
209+
"type": "string"
210+
}
211+
},
212+
"required": [
213+
"id"
214+
],
215+
"type": "object"
216+
},
217+
"AuditLogEntryRequestResponse": {
218+
"description": "Request, which mirrors the action of the user and the resulting changes within the system",
219+
"properties": {
220+
"body": {
221+
"description": "Body used to make the request.",
222+
"type": "object"
223+
},
224+
"endpoint": {
225+
"description": "Endpoint which received the request.",
226+
"maxLength": 255,
227+
"minLength": 1,
228+
"type": "string"
229+
},
230+
"headers": {
231+
"description": "Headers used to make the request. May only contain (string -\u003e string) key-value pairs.",
232+
"type": "object"
233+
},
234+
"parameters": {
235+
"description": "Parameters used to make the request.",
236+
"type": "object"
237+
}
238+
},
239+
"required": [
240+
"endpoint"
241+
],
242+
"title": "request",
243+
"type": "object"
244+
},
245+
"AuditLogEntryResponse": {
158246
"properties": {
159247
"context": {
160-
"$ref": "#/components/schemas/context"
248+
"$ref": "#/components/schemas/AuditLogEntryContextResponse"
161249
},
162250
"correlationId": {
163251
"description": "Unique ID which identifies the request from the sender point of view.",
@@ -166,7 +254,7 @@
166254
"type": "string"
167255
},
168256
"details": {
169-
"$ref": "#/components/schemas/details"
257+
"$ref": "#/components/schemas/AuditLogEntryDetailsResponse"
170258
},
171259
"eventName": {
172260
"description": "Name of the operation this event represents.",
@@ -201,7 +289,7 @@
201289
"type": "string"
202290
},
203291
"initiator": {
204-
"$ref": "#/components/schemas/initiator"
292+
"$ref": "#/components/schemas/AuditLogEntryInitiatorResponse"
205293
},
206294
"receivedTimeStamp": {
207295
"description": "Timestamp at which the event was received by the audit log.",
@@ -213,7 +301,7 @@
213301
"type": "string"
214302
},
215303
"request": {
216-
"$ref": "#/components/schemas/request"
304+
"$ref": "#/components/schemas/AuditLogEntryRequestResponse"
217305
},
218306
"resourceId": {
219307
"description": "Unique id of the resource that is target of the operation",
@@ -228,10 +316,10 @@
228316
"type": "string"
229317
},
230318
"result": {
231-
"$ref": "#/components/schemas/result"
319+
"$ref": "#/components/schemas/AuditLogEntryResultResponse"
232320
},
233321
"serviceAccountDelegationInfo": {
234-
"$ref": "#/components/schemas/serviceAccountDelegationInfo"
322+
"$ref": "#/components/schemas/AuditLogEntryServiceAccountDelegationInfoResponse"
235323
},
236324
"severity": {
237325
"description": "The severity of this request.",
@@ -280,55 +368,27 @@
280368
"title": "auditLogEntry",
281369
"type": "object"
282370
},
283-
"context": {
284-
"description": "Request context",
285-
"properties": {
286-
"folderId": {
287-
"description": "Folder id",
288-
"maxLength": 255,
289-
"minLength": 1,
290-
"type": "string"
291-
},
292-
"organizationId": {
293-
"description": "Organization id",
294-
"maxLength": 255,
295-
"minLength": 1,
296-
"type": "string"
297-
},
298-
"projectId": {
299-
"description": "Project id",
300-
"maxLength": 255,
301-
"minLength": 1,
302-
"type": "string"
303-
}
304-
},
371+
"AuditLogEntryResultResponse": {
372+
"description": "Object representing the change resulting from this event. May be omitted if no change has been applied. May contain arbitrary data.",
305373
"type": "object"
306374
},
307-
"delegationPrincipal": {
308-
"description": "Principal in delegation chain of a service account",
375+
"AuditLogEntryServiceAccountDelegationInfoResponse": {
376+
"description": "Information about service account delegation",
309377
"properties": {
310-
"email": {
311-
"description": "E-Mail of the subject",
312-
"format": "email",
313-
"maxLength": 255,
314-
"minLength": 1,
315-
"type": "string"
316-
},
317-
"id": {
318-
"description": "Unique identifier of the subject",
319-
"type": "string"
378+
"principals": {
379+
"description": "Delegation chain for the service account",
380+
"items": {
381+
"$ref": "#/components/schemas/ServiceAccountDelegationInfoPrincipalResponse"
382+
},
383+
"type": "array"
320384
}
321385
},
322386
"required": [
323-
"id"
387+
"principals"
324388
],
325389
"type": "object"
326390
},
327-
"details": {
328-
"description": "Additional information about the event that is not part of the request or response. May contain arbitrary data.",
329-
"type": "object"
330-
},
331-
"error": {
391+
"ErrorResponse": {
332392
"properties": {
333393
"message": {
334394
"description": "Description of the error.",
@@ -354,7 +414,7 @@
354414
"title": "error",
355415
"type": "object"
356416
},
357-
"gatewayError": {
417+
"GatewayErrorResponse": {
358418
"properties": {
359419
"message": {
360420
"description": "Description of the error.",
@@ -368,73 +428,25 @@
368428
"title": "gatewayError",
369429
"type": "object"
370430
},
371-
"initiator": {
372-
"description": "Information about who made the request.",
431+
"ServiceAccountDelegationInfoPrincipalResponse": {
432+
"description": "Principal in delegation chain of a service account",
373433
"properties": {
374434
"email": {
375-
"description": "E-Mail of the user or service account who triggered the request",
435+
"description": "E-Mail of the subject",
376436
"format": "email",
377437
"maxLength": 255,
378438
"minLength": 1,
379439
"type": "string"
380440
},
381441
"id": {
382-
"description": "Unique identifier of the user",
442+
"description": "Unique identifier of the subject",
383443
"type": "string"
384444
}
385445
},
386446
"required": [
387447
"id"
388448
],
389449
"type": "object"
390-
},
391-
"request": {
392-
"description": "Request, which mirrors the action of the user and the resulting changes within the system",
393-
"properties": {
394-
"body": {
395-
"description": "Body used to make the request.",
396-
"type": "object"
397-
},
398-
"endpoint": {
399-
"description": "Endpoint which received the request.",
400-
"maxLength": 255,
401-
"minLength": 1,
402-
"type": "string"
403-
},
404-
"headers": {
405-
"description": "Headers used to make the request. May only contain (string -\u003e string) key-value pairs.",
406-
"type": "object"
407-
},
408-
"parameters": {
409-
"description": "Parameters used to make the request.",
410-
"type": "object"
411-
}
412-
},
413-
"required": [
414-
"endpoint"
415-
],
416-
"title": "request",
417-
"type": "object"
418-
},
419-
"result": {
420-
"description": "Object representing the change resulting from this event. May be omitted if no change has been applied. May contain arbitrary data.",
421-
"type": "object"
422-
},
423-
"serviceAccountDelegationInfo": {
424-
"description": "Information about service account delegation",
425-
"properties": {
426-
"principals": {
427-
"description": "Delegation chain for the service account",
428-
"items": {
429-
"$ref": "#/components/schemas/delegationPrincipal"
430-
},
431-
"type": "array"
432-
}
433-
},
434-
"required": [
435-
"principals"
436-
],
437-
"type": "object"
438450
}
439451
}
440452
},

0 commit comments

Comments
 (0)