@ogcio/building-blocks-sdk 0.2.70 → 0.2.72
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitleaksignore +10 -1
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +14 -0
- package/dist/client/clients/audit/index.d.ts +132 -0
- package/dist/client/clients/audit/index.d.ts.map +1 -0
- package/dist/client/clients/audit/index.js +14 -0
- package/dist/client/clients/audit/index.js.map +1 -0
- package/dist/client/clients/audit/schema.d.ts +246 -0
- package/dist/client/clients/audit/schema.d.ts.map +1 -0
- package/dist/client/clients/audit/schema.js +2 -0
- package/dist/client/clients/audit/schema.js.map +1 -0
- package/dist/client/clients/payments/index.d.ts +138 -2
- package/dist/client/clients/payments/index.d.ts.map +1 -1
- package/dist/client/clients/payments/index.js +9 -0
- package/dist/client/clients/payments/index.js.map +1 -1
- package/dist/client/clients/payments/schema.d.ts +206 -4
- package/dist/client/clients/payments/schema.d.ts.map +1 -1
- package/dist/clients-configurations/clients-configuration.json +10 -2
- package/dist/types/index.d.ts +9 -3
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +2 -1
- package/dist/types/index.js.map +1 -1
- package/package.json +1 -1
- package/src/client/clients/audit/index.ts +25 -0
- package/src/client/clients/audit/open-api-definition.json +433 -0
- package/src/client/clients/audit/schema.ts +245 -0
- package/src/client/clients/payments/index.ts +15 -0
- package/src/client/clients/payments/open-api-definition.json +966 -38
- package/src/client/clients/payments/schema.ts +206 -4
- package/src/clients-configurations/clients-configuration.json +10 -2
- package/src/types/index.ts +10 -2
|
@@ -0,0 +1,433 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.3",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "OGCIO Fastify Scaffolding API",
|
|
5
|
+
"description": "API for OGCIO Fastify Scaffolding",
|
|
6
|
+
"version": "0.1.0"
|
|
7
|
+
},
|
|
8
|
+
"components": {
|
|
9
|
+
"securitySchemes": {
|
|
10
|
+
"bearerAuth": {
|
|
11
|
+
"type": "http",
|
|
12
|
+
"scheme": "bearer",
|
|
13
|
+
"bearerFormat": "JWT"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"schemas": {}
|
|
17
|
+
},
|
|
18
|
+
"paths": {
|
|
19
|
+
"/health": {
|
|
20
|
+
"get": {
|
|
21
|
+
"tags": [
|
|
22
|
+
"Health"
|
|
23
|
+
],
|
|
24
|
+
"description": "It checks the current health status of the APIs, pinging all the related items",
|
|
25
|
+
"responses": {
|
|
26
|
+
"200": {
|
|
27
|
+
"description": "Default Response"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"/api/v1/audit-logs/": {
|
|
33
|
+
"post": {
|
|
34
|
+
"operationId": "createAuditLog",
|
|
35
|
+
"tags": [
|
|
36
|
+
"Audit Logs"
|
|
37
|
+
],
|
|
38
|
+
"requestBody": {
|
|
39
|
+
"content": {
|
|
40
|
+
"application/json": {
|
|
41
|
+
"schema": {
|
|
42
|
+
"type": "array",
|
|
43
|
+
"items": {
|
|
44
|
+
"type": "object",
|
|
45
|
+
"required": [
|
|
46
|
+
"application_id",
|
|
47
|
+
"action_type",
|
|
48
|
+
"resource_type",
|
|
49
|
+
"client_timestamp",
|
|
50
|
+
"metadata"
|
|
51
|
+
],
|
|
52
|
+
"properties": {
|
|
53
|
+
"application_id": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"minLength": 1,
|
|
56
|
+
"maxLength": 255,
|
|
57
|
+
"description": "Identifies the client application/service",
|
|
58
|
+
"example": "my-app"
|
|
59
|
+
},
|
|
60
|
+
"application_version": {
|
|
61
|
+
"type": "string",
|
|
62
|
+
"maxLength": 50,
|
|
63
|
+
"description": "Optional application version for schema tracking",
|
|
64
|
+
"example": "1.4.3"
|
|
65
|
+
},
|
|
66
|
+
"user_id": {
|
|
67
|
+
"type": "string",
|
|
68
|
+
"maxLength": 255,
|
|
69
|
+
"description": "JWT subject; null indicates M2M action",
|
|
70
|
+
"example": "user-123"
|
|
71
|
+
},
|
|
72
|
+
"user_email_address": {
|
|
73
|
+
"type": "string",
|
|
74
|
+
"maxLength": 255,
|
|
75
|
+
"format": "email",
|
|
76
|
+
"description": "User email for human-readable context",
|
|
77
|
+
"example": "user@example.com"
|
|
78
|
+
},
|
|
79
|
+
"action_type": {
|
|
80
|
+
"enum": [
|
|
81
|
+
"read",
|
|
82
|
+
"create",
|
|
83
|
+
"update",
|
|
84
|
+
"delete",
|
|
85
|
+
"list"
|
|
86
|
+
],
|
|
87
|
+
"description": "Operation: Read, Create, Update, Delete, etc.",
|
|
88
|
+
"example": "create"
|
|
89
|
+
},
|
|
90
|
+
"resource_type": {
|
|
91
|
+
"type": "string",
|
|
92
|
+
"minLength": 1,
|
|
93
|
+
"maxLength": 100,
|
|
94
|
+
"description": "Entity type affected: user, message, etc.",
|
|
95
|
+
"example": "user"
|
|
96
|
+
},
|
|
97
|
+
"resource_id": {
|
|
98
|
+
"type": "string",
|
|
99
|
+
"maxLength": 255,
|
|
100
|
+
"description": "Specific resource identifier; null for list operations",
|
|
101
|
+
"example": "user-123"
|
|
102
|
+
},
|
|
103
|
+
"client_timestamp": {
|
|
104
|
+
"type": "string",
|
|
105
|
+
"format": "date-time",
|
|
106
|
+
"description": "ISO 8601 client-reported timestamp",
|
|
107
|
+
"example": "2025-12-19T10:30:00Z"
|
|
108
|
+
},
|
|
109
|
+
"successful": {
|
|
110
|
+
"anyOf": [
|
|
111
|
+
{
|
|
112
|
+
"type": "boolean",
|
|
113
|
+
"description": "Operation outcome: true=success, false=failure, null=not applicable",
|
|
114
|
+
"examples": [
|
|
115
|
+
true,
|
|
116
|
+
false
|
|
117
|
+
]
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"type": "null"
|
|
121
|
+
}
|
|
122
|
+
]
|
|
123
|
+
},
|
|
124
|
+
"failure_reason": {
|
|
125
|
+
"anyOf": [
|
|
126
|
+
{
|
|
127
|
+
"type": "string",
|
|
128
|
+
"description": "Human-readable failure reason (optional)",
|
|
129
|
+
"examples": [
|
|
130
|
+
"Invalid email address"
|
|
131
|
+
]
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"type": "null"
|
|
135
|
+
}
|
|
136
|
+
]
|
|
137
|
+
},
|
|
138
|
+
"server_id": {
|
|
139
|
+
"anyOf": [
|
|
140
|
+
{
|
|
141
|
+
"type": "string",
|
|
142
|
+
"maxLength": 255,
|
|
143
|
+
"description": "Pod/instance ID of receiving server (optional)",
|
|
144
|
+
"examples": [
|
|
145
|
+
"pod-01"
|
|
146
|
+
]
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"type": "null"
|
|
150
|
+
}
|
|
151
|
+
]
|
|
152
|
+
},
|
|
153
|
+
"metadata": {
|
|
154
|
+
"type": "object",
|
|
155
|
+
"properties": {},
|
|
156
|
+
"additionalProperties": true,
|
|
157
|
+
"description": "Extensible JSON context for event",
|
|
158
|
+
"example": {
|
|
159
|
+
"request_id": "req-123",
|
|
160
|
+
"source": "web"
|
|
161
|
+
}
|
|
162
|
+
},
|
|
163
|
+
"parent_log_entry_id": {
|
|
164
|
+
"anyOf": [
|
|
165
|
+
{
|
|
166
|
+
"type": "string",
|
|
167
|
+
"format": "uuid",
|
|
168
|
+
"description": "Related audit event UUID",
|
|
169
|
+
"examples": [
|
|
170
|
+
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
|
|
171
|
+
]
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"type": "null"
|
|
175
|
+
}
|
|
176
|
+
]
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
},
|
|
180
|
+
"minItems": 1,
|
|
181
|
+
"maxItems": 20
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
},
|
|
186
|
+
"responses": {
|
|
187
|
+
"200": {
|
|
188
|
+
"description": "Default Response",
|
|
189
|
+
"content": {
|
|
190
|
+
"application/json": {
|
|
191
|
+
"schema": {
|
|
192
|
+
"type": "object",
|
|
193
|
+
"required": [
|
|
194
|
+
"data"
|
|
195
|
+
],
|
|
196
|
+
"properties": {
|
|
197
|
+
"data": {
|
|
198
|
+
"type": "array",
|
|
199
|
+
"items": {
|
|
200
|
+
"type": "object",
|
|
201
|
+
"required": [
|
|
202
|
+
"id"
|
|
203
|
+
],
|
|
204
|
+
"properties": {
|
|
205
|
+
"id": {
|
|
206
|
+
"type": "string",
|
|
207
|
+
"format": "uuid"
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
},
|
|
211
|
+
"description": "Multiple audit log entries created",
|
|
212
|
+
"example": [
|
|
213
|
+
{
|
|
214
|
+
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
"id": "9c858901-8a57-4791-81fe-4c455b099bc9"
|
|
218
|
+
}
|
|
219
|
+
]
|
|
220
|
+
},
|
|
221
|
+
"metadata": {
|
|
222
|
+
"type": "object",
|
|
223
|
+
"properties": {
|
|
224
|
+
"links": {
|
|
225
|
+
"type": "object",
|
|
226
|
+
"required": [
|
|
227
|
+
"self",
|
|
228
|
+
"first",
|
|
229
|
+
"last",
|
|
230
|
+
"pages"
|
|
231
|
+
],
|
|
232
|
+
"properties": {
|
|
233
|
+
"self": {
|
|
234
|
+
"type": "object",
|
|
235
|
+
"properties": {
|
|
236
|
+
"href": {
|
|
237
|
+
"type": "string",
|
|
238
|
+
"description": "URL pointing to the request itself"
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
},
|
|
242
|
+
"next": {
|
|
243
|
+
"type": "object",
|
|
244
|
+
"properties": {
|
|
245
|
+
"href": {
|
|
246
|
+
"type": "string",
|
|
247
|
+
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
},
|
|
251
|
+
"prev": {
|
|
252
|
+
"type": "object",
|
|
253
|
+
"properties": {
|
|
254
|
+
"href": {
|
|
255
|
+
"type": "string",
|
|
256
|
+
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
},
|
|
260
|
+
"first": {
|
|
261
|
+
"type": "object",
|
|
262
|
+
"properties": {
|
|
263
|
+
"href": {
|
|
264
|
+
"type": "string",
|
|
265
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
266
|
+
}
|
|
267
|
+
}
|
|
268
|
+
},
|
|
269
|
+
"last": {
|
|
270
|
+
"type": "object",
|
|
271
|
+
"properties": {
|
|
272
|
+
"href": {
|
|
273
|
+
"type": "string",
|
|
274
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
},
|
|
278
|
+
"pages": {
|
|
279
|
+
"type": "object",
|
|
280
|
+
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
281
|
+
"additionalProperties": {
|
|
282
|
+
"type": "object",
|
|
283
|
+
"properties": {
|
|
284
|
+
"href": {
|
|
285
|
+
"type": "string"
|
|
286
|
+
}
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
},
|
|
291
|
+
"description": "Object containing the links to the related endpoints"
|
|
292
|
+
},
|
|
293
|
+
"totalCount": {
|
|
294
|
+
"type": "number",
|
|
295
|
+
"description": "Number representing the total number of available items"
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
},
|
|
304
|
+
"4XX": {
|
|
305
|
+
"description": "Default Response",
|
|
306
|
+
"content": {
|
|
307
|
+
"application/json": {
|
|
308
|
+
"schema": {
|
|
309
|
+
"type": "object",
|
|
310
|
+
"required": [
|
|
311
|
+
"code",
|
|
312
|
+
"detail",
|
|
313
|
+
"requestId",
|
|
314
|
+
"name",
|
|
315
|
+
"statusCode"
|
|
316
|
+
],
|
|
317
|
+
"properties": {
|
|
318
|
+
"code": {
|
|
319
|
+
"type": "string",
|
|
320
|
+
"description": "Code used to categorize the error"
|
|
321
|
+
},
|
|
322
|
+
"detail": {
|
|
323
|
+
"type": "string",
|
|
324
|
+
"description": "Description of the error"
|
|
325
|
+
},
|
|
326
|
+
"requestId": {
|
|
327
|
+
"type": "string",
|
|
328
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
329
|
+
},
|
|
330
|
+
"name": {
|
|
331
|
+
"type": "string",
|
|
332
|
+
"description": "Name of the error type"
|
|
333
|
+
},
|
|
334
|
+
"validation": {
|
|
335
|
+
"type": "array",
|
|
336
|
+
"items": {
|
|
337
|
+
"type": "object",
|
|
338
|
+
"required": [
|
|
339
|
+
"fieldName",
|
|
340
|
+
"message"
|
|
341
|
+
],
|
|
342
|
+
"properties": {
|
|
343
|
+
"fieldName": {
|
|
344
|
+
"type": "string"
|
|
345
|
+
},
|
|
346
|
+
"message": {
|
|
347
|
+
"type": "string"
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
"description": "List of the validation errors"
|
|
352
|
+
},
|
|
353
|
+
"validationContext": {
|
|
354
|
+
"type": "string"
|
|
355
|
+
},
|
|
356
|
+
"statusCode": {
|
|
357
|
+
"type": "number"
|
|
358
|
+
}
|
|
359
|
+
}
|
|
360
|
+
}
|
|
361
|
+
}
|
|
362
|
+
}
|
|
363
|
+
},
|
|
364
|
+
"5XX": {
|
|
365
|
+
"description": "Default Response",
|
|
366
|
+
"content": {
|
|
367
|
+
"application/json": {
|
|
368
|
+
"schema": {
|
|
369
|
+
"type": "object",
|
|
370
|
+
"required": [
|
|
371
|
+
"code",
|
|
372
|
+
"detail",
|
|
373
|
+
"requestId",
|
|
374
|
+
"name",
|
|
375
|
+
"statusCode"
|
|
376
|
+
],
|
|
377
|
+
"properties": {
|
|
378
|
+
"code": {
|
|
379
|
+
"type": "string",
|
|
380
|
+
"description": "Code used to categorize the error"
|
|
381
|
+
},
|
|
382
|
+
"detail": {
|
|
383
|
+
"type": "string",
|
|
384
|
+
"description": "Description of the error"
|
|
385
|
+
},
|
|
386
|
+
"requestId": {
|
|
387
|
+
"type": "string",
|
|
388
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
389
|
+
},
|
|
390
|
+
"name": {
|
|
391
|
+
"type": "string",
|
|
392
|
+
"description": "Name of the error type"
|
|
393
|
+
},
|
|
394
|
+
"validation": {
|
|
395
|
+
"type": "array",
|
|
396
|
+
"items": {
|
|
397
|
+
"type": "object",
|
|
398
|
+
"required": [
|
|
399
|
+
"fieldName",
|
|
400
|
+
"message"
|
|
401
|
+
],
|
|
402
|
+
"properties": {
|
|
403
|
+
"fieldName": {
|
|
404
|
+
"type": "string"
|
|
405
|
+
},
|
|
406
|
+
"message": {
|
|
407
|
+
"type": "string"
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
},
|
|
411
|
+
"description": "List of the validation errors"
|
|
412
|
+
},
|
|
413
|
+
"validationContext": {
|
|
414
|
+
"type": "string"
|
|
415
|
+
},
|
|
416
|
+
"statusCode": {
|
|
417
|
+
"type": "number"
|
|
418
|
+
}
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
}
|
|
422
|
+
}
|
|
423
|
+
}
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
},
|
|
428
|
+
"security": [
|
|
429
|
+
{
|
|
430
|
+
"bearerAuth": []
|
|
431
|
+
}
|
|
432
|
+
]
|
|
433
|
+
}
|
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
export interface paths {
|
|
2
|
+
"/health": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/** @description It checks the current health status of the APIs, pinging all the related items */
|
|
10
|
+
get: {
|
|
11
|
+
parameters: {
|
|
12
|
+
query?: never;
|
|
13
|
+
header?: never;
|
|
14
|
+
path?: never;
|
|
15
|
+
cookie?: never;
|
|
16
|
+
};
|
|
17
|
+
requestBody?: never;
|
|
18
|
+
responses: {
|
|
19
|
+
/** @description Default Response */
|
|
20
|
+
200: {
|
|
21
|
+
headers: {
|
|
22
|
+
[name: string]: unknown;
|
|
23
|
+
};
|
|
24
|
+
content?: never;
|
|
25
|
+
};
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
put?: never;
|
|
29
|
+
post?: never;
|
|
30
|
+
delete?: never;
|
|
31
|
+
options?: never;
|
|
32
|
+
head?: never;
|
|
33
|
+
patch?: never;
|
|
34
|
+
trace?: never;
|
|
35
|
+
};
|
|
36
|
+
"/api/v1/audit-logs/": {
|
|
37
|
+
parameters: {
|
|
38
|
+
query?: never;
|
|
39
|
+
header?: never;
|
|
40
|
+
path?: never;
|
|
41
|
+
cookie?: never;
|
|
42
|
+
};
|
|
43
|
+
get?: never;
|
|
44
|
+
put?: never;
|
|
45
|
+
post: operations["createAuditLog"];
|
|
46
|
+
delete?: never;
|
|
47
|
+
options?: never;
|
|
48
|
+
head?: never;
|
|
49
|
+
patch?: never;
|
|
50
|
+
trace?: never;
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
export type webhooks = Record<string, never>;
|
|
54
|
+
export interface components {
|
|
55
|
+
schemas: never;
|
|
56
|
+
responses: never;
|
|
57
|
+
parameters: never;
|
|
58
|
+
requestBodies: never;
|
|
59
|
+
headers: never;
|
|
60
|
+
pathItems: never;
|
|
61
|
+
}
|
|
62
|
+
export type $defs = Record<string, never>;
|
|
63
|
+
export interface operations {
|
|
64
|
+
createAuditLog: {
|
|
65
|
+
parameters: {
|
|
66
|
+
query?: never;
|
|
67
|
+
header?: never;
|
|
68
|
+
path?: never;
|
|
69
|
+
cookie?: never;
|
|
70
|
+
};
|
|
71
|
+
requestBody?: {
|
|
72
|
+
content: {
|
|
73
|
+
"application/json": {
|
|
74
|
+
/**
|
|
75
|
+
* @description Identifies the client application/service
|
|
76
|
+
* @example my-app
|
|
77
|
+
*/
|
|
78
|
+
application_id: string;
|
|
79
|
+
/**
|
|
80
|
+
* @description Optional application version for schema tracking
|
|
81
|
+
* @example 1.4.3
|
|
82
|
+
*/
|
|
83
|
+
application_version?: string;
|
|
84
|
+
/**
|
|
85
|
+
* @description JWT subject; null indicates M2M action
|
|
86
|
+
* @example user-123
|
|
87
|
+
*/
|
|
88
|
+
user_id?: string;
|
|
89
|
+
/**
|
|
90
|
+
* Format: email
|
|
91
|
+
* @description User email for human-readable context
|
|
92
|
+
* @example user@example.com
|
|
93
|
+
*/
|
|
94
|
+
user_email_address?: string;
|
|
95
|
+
/**
|
|
96
|
+
* @description Operation: Read, Create, Update, Delete, etc.
|
|
97
|
+
* @example create
|
|
98
|
+
* @enum {unknown}
|
|
99
|
+
*/
|
|
100
|
+
action_type: "read" | "create" | "update" | "delete" | "list";
|
|
101
|
+
/**
|
|
102
|
+
* @description Entity type affected: user, message, etc.
|
|
103
|
+
* @example user
|
|
104
|
+
*/
|
|
105
|
+
resource_type: string;
|
|
106
|
+
/**
|
|
107
|
+
* @description Specific resource identifier; null for list operations
|
|
108
|
+
* @example user-123
|
|
109
|
+
*/
|
|
110
|
+
resource_id?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Format: date-time
|
|
113
|
+
* @description ISO 8601 client-reported timestamp
|
|
114
|
+
* @example 2025-12-19T10:30:00Z
|
|
115
|
+
*/
|
|
116
|
+
client_timestamp: string;
|
|
117
|
+
successful?: boolean | null;
|
|
118
|
+
failure_reason?: string | null;
|
|
119
|
+
server_id?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* @description Extensible JSON context for event
|
|
122
|
+
* @example {
|
|
123
|
+
* "request_id": "req-123",
|
|
124
|
+
* "source": "web"
|
|
125
|
+
* }
|
|
126
|
+
*/
|
|
127
|
+
metadata: {
|
|
128
|
+
[key: string]: unknown;
|
|
129
|
+
};
|
|
130
|
+
parent_log_entry_id?: string | null;
|
|
131
|
+
}[];
|
|
132
|
+
};
|
|
133
|
+
};
|
|
134
|
+
responses: {
|
|
135
|
+
/** @description Default Response */
|
|
136
|
+
200: {
|
|
137
|
+
headers: {
|
|
138
|
+
[name: string]: unknown;
|
|
139
|
+
};
|
|
140
|
+
content: {
|
|
141
|
+
"application/json": {
|
|
142
|
+
/**
|
|
143
|
+
* @description Multiple audit log entries created
|
|
144
|
+
* @example [
|
|
145
|
+
* {
|
|
146
|
+
* "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
|
|
147
|
+
* },
|
|
148
|
+
* {
|
|
149
|
+
* "id": "9c858901-8a57-4791-81fe-4c455b099bc9"
|
|
150
|
+
* }
|
|
151
|
+
* ]
|
|
152
|
+
*/
|
|
153
|
+
data: {
|
|
154
|
+
/** Format: uuid */
|
|
155
|
+
id: string;
|
|
156
|
+
}[];
|
|
157
|
+
metadata?: {
|
|
158
|
+
/** @description Object containing the links to the related endpoints */
|
|
159
|
+
links?: {
|
|
160
|
+
self: {
|
|
161
|
+
/** @description URL pointing to the request itself */
|
|
162
|
+
href?: string;
|
|
163
|
+
};
|
|
164
|
+
next?: {
|
|
165
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
166
|
+
href?: string;
|
|
167
|
+
};
|
|
168
|
+
prev?: {
|
|
169
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
170
|
+
href?: string;
|
|
171
|
+
};
|
|
172
|
+
first: {
|
|
173
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
174
|
+
href?: string;
|
|
175
|
+
};
|
|
176
|
+
last: {
|
|
177
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
178
|
+
href?: string;
|
|
179
|
+
};
|
|
180
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
181
|
+
pages: {
|
|
182
|
+
[key: string]: {
|
|
183
|
+
href?: string;
|
|
184
|
+
};
|
|
185
|
+
};
|
|
186
|
+
};
|
|
187
|
+
/** @description Number representing the total number of available items */
|
|
188
|
+
totalCount?: number;
|
|
189
|
+
};
|
|
190
|
+
};
|
|
191
|
+
};
|
|
192
|
+
};
|
|
193
|
+
/** @description Default Response */
|
|
194
|
+
"4XX": {
|
|
195
|
+
headers: {
|
|
196
|
+
[name: string]: unknown;
|
|
197
|
+
};
|
|
198
|
+
content: {
|
|
199
|
+
"application/json": {
|
|
200
|
+
/** @description Code used to categorize the error */
|
|
201
|
+
code: string;
|
|
202
|
+
/** @description Description of the error */
|
|
203
|
+
detail: string;
|
|
204
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
205
|
+
requestId: string;
|
|
206
|
+
/** @description Name of the error type */
|
|
207
|
+
name: string;
|
|
208
|
+
/** @description List of the validation errors */
|
|
209
|
+
validation?: {
|
|
210
|
+
fieldName: string;
|
|
211
|
+
message: string;
|
|
212
|
+
}[];
|
|
213
|
+
validationContext?: string;
|
|
214
|
+
statusCode: number;
|
|
215
|
+
};
|
|
216
|
+
};
|
|
217
|
+
};
|
|
218
|
+
/** @description Default Response */
|
|
219
|
+
"5XX": {
|
|
220
|
+
headers: {
|
|
221
|
+
[name: string]: unknown;
|
|
222
|
+
};
|
|
223
|
+
content: {
|
|
224
|
+
"application/json": {
|
|
225
|
+
/** @description Code used to categorize the error */
|
|
226
|
+
code: string;
|
|
227
|
+
/** @description Description of the error */
|
|
228
|
+
detail: string;
|
|
229
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
230
|
+
requestId: string;
|
|
231
|
+
/** @description Name of the error type */
|
|
232
|
+
name: string;
|
|
233
|
+
/** @description List of the validation errors */
|
|
234
|
+
validation?: {
|
|
235
|
+
fieldName: string;
|
|
236
|
+
message: string;
|
|
237
|
+
}[];
|
|
238
|
+
validationContext?: string;
|
|
239
|
+
statusCode: number;
|
|
240
|
+
};
|
|
241
|
+
};
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
};
|
|
245
|
+
}
|