@mgrzmil-org/api-types 0.0.0 → 0.0.2

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.
Files changed (3) hide show
  1. package/openapi.json +702 -574
  2. package/package.json +5 -1
  3. package/src/api.ts +61 -15
package/openapi.json CHANGED
@@ -1,575 +1,703 @@
1
- {
2
- "openapi": "3.1.0",
3
- "info": {
4
- "title": "dog-api",
5
- "description": "API for accessing dog breed images and information",
6
- "version": "1.0.0",
7
- "contact": {
8
- "name": "API Support"
9
- }
10
- },
11
- "paths": {
12
- "/breeds/list/all": {
13
- "get": {
14
- "tags": [
15
- "Breeds"
16
- ],
17
- "summary": "List all breeds",
18
- "description": "Returns a list of all available dog breeds and their sub-breeds",
19
- "operationId": "list_all_breeds_breeds_list_all_get",
20
- "responses": {
21
- "200": {
22
- "description": "Successful Response",
23
- "content": {
24
- "application/json": {
25
- "schema": {
26
- "$ref": "#/components/schemas/APIResponse"
27
- }
28
- }
29
- }
30
- }
31
- }
32
- }
33
- },
34
- "/breed/{breed}/list": {
35
- "get": {
36
- "tags": [
37
- "Breeds"
38
- ],
39
- "summary": "Get breed sub-breeds",
40
- "description": "Returns a list of sub-breeds for a specific breed -",
41
- "operationId": "breed_subbreeds_breed__breed__list_get",
42
- "parameters": [
43
- {
44
- "name": "breed",
45
- "in": "path",
46
- "required": true,
47
- "schema": {
48
- "type": "string",
49
- "title": "Breed"
50
- }
51
- }
52
- ],
53
- "responses": {
54
- "200": {
55
- "description": "Successful Response",
56
- "content": {
57
- "application/json": {
58
- "schema": {
59
- "$ref": "#/components/schemas/APIResponse"
60
- }
61
- }
62
- }
63
- },
64
- "422": {
65
- "description": "Validation Error",
66
- "content": {
67
- "application/json": {
68
- "schema": {
69
- "$ref": "#/components/schemas/HTTPValidationError"
70
- }
71
- }
72
- }
73
- }
74
- }
75
- }
76
- },
77
- "/breeds/image/random": {
78
- "get": {
79
- "tags": [
80
- "Images"
81
- ],
82
- "summary": "Get random image",
83
- "description": "Returns a random dog image URL from all available breeds",
84
- "operationId": "random_image_breeds_image_random_get",
85
- "responses": {
86
- "200": {
87
- "description": "Successful Response",
88
- "content": {
89
- "application/json": {
90
- "schema": {
91
- "$ref": "#/components/schemas/APIResponse"
92
- }
93
- }
94
- }
95
- }
96
- }
97
- }
98
- },
99
- "/breed/{breed}/images": {
100
- "get": {
101
- "tags": [
102
- "Images"
103
- ],
104
- "summary": "Get breed images",
105
- "description": "Returns all image URLs for a specific breed",
106
- "operationId": "breed_images_breed__breed__images_get",
107
- "parameters": [
108
- {
109
- "name": "breed",
110
- "in": "path",
111
- "required": true,
112
- "schema": {
113
- "type": "string",
114
- "title": "Breed"
115
- }
116
- }
117
- ],
118
- "responses": {
119
- "200": {
120
- "description": "Successful Response",
121
- "content": {
122
- "application/json": {
123
- "schema": {
124
- "$ref": "#/components/schemas/APIResponse"
125
- }
126
- }
127
- }
128
- },
129
- "422": {
130
- "description": "Validation Error",
131
- "content": {
132
- "application/json": {
133
- "schema": {
134
- "$ref": "#/components/schemas/HTTPValidationError"
135
- }
136
- }
137
- }
138
- }
139
- }
140
- }
141
- },
142
- "/breed/{breed}/images/random": {
143
- "get": {
144
- "tags": [
145
- "Images"
146
- ],
147
- "summary": "Get random breed image",
148
- "description": "Returns a random image URL for a specific breed",
149
- "operationId": "random_breed_image_breed__breed__images_random_get",
150
- "parameters": [
151
- {
152
- "name": "breed",
153
- "in": "path",
154
- "required": true,
155
- "schema": {
156
- "type": "string",
157
- "title": "Breed"
158
- }
159
- }
160
- ],
161
- "responses": {
162
- "200": {
163
- "description": "Successful Response",
164
- "content": {
165
- "application/json": {
166
- "schema": {
167
- "$ref": "#/components/schemas/APIResponse"
168
- }
169
- }
170
- }
171
- },
172
- "422": {
173
- "description": "Validation Error",
174
- "content": {
175
- "application/json": {
176
- "schema": {
177
- "$ref": "#/components/schemas/HTTPValidationError"
178
- }
179
- }
180
- }
181
- }
182
- }
183
- }
184
- },
185
- "/breed/{breed}/{subbreed}/images": {
186
- "get": {
187
- "tags": [
188
- "Images"
189
- ],
190
- "summary": "Get sub-breed images",
191
- "description": "Returns all image URLs for a specific sub-breed",
192
- "operationId": "subbreed_images_breed__breed___subbreed__images_get",
193
- "parameters": [
194
- {
195
- "name": "breed",
196
- "in": "path",
197
- "required": true,
198
- "schema": {
199
- "type": "string",
200
- "title": "Breed"
201
- }
202
- },
203
- {
204
- "name": "subbreed",
205
- "in": "path",
206
- "required": true,
207
- "schema": {
208
- "type": "string",
209
- "title": "Subbreed"
210
- }
211
- }
212
- ],
213
- "responses": {
214
- "200": {
215
- "description": "Successful Response",
216
- "content": {
217
- "application/json": {
218
- "schema": {
219
- "$ref": "#/components/schemas/APIResponse"
220
- }
221
- }
222
- }
223
- },
224
- "422": {
225
- "description": "Validation Error",
226
- "content": {
227
- "application/json": {
228
- "schema": {
229
- "$ref": "#/components/schemas/HTTPValidationError"
230
- }
231
- }
232
- }
233
- }
234
- }
235
- }
236
- },
237
- "/breed/{breed}/{subbreed}/images/random": {
238
- "get": {
239
- "tags": [
240
- "Images"
241
- ],
242
- "summary": "Get random sub-breed image",
243
- "description": "Returns a random image URL for a specific sub-breed",
244
- "operationId": "random_subbreed_image_breed__breed___subbreed__images_random_get",
245
- "parameters": [
246
- {
247
- "name": "breed",
248
- "in": "path",
249
- "required": true,
250
- "schema": {
251
- "type": "string",
252
- "title": "Breed"
253
- }
254
- },
255
- {
256
- "name": "subbreed",
257
- "in": "path",
258
- "required": true,
259
- "schema": {
260
- "type": "string",
261
- "title": "Subbreed"
262
- }
263
- }
264
- ],
265
- "responses": {
266
- "200": {
267
- "description": "Successful Response",
268
- "content": {
269
- "application/json": {
270
- "schema": {
271
- "$ref": "#/components/schemas/APIResponse"
272
- }
273
- }
274
- }
275
- },
276
- "422": {
277
- "description": "Validation Error",
278
- "content": {
279
- "application/json": {
280
- "schema": {
281
- "$ref": "#/components/schemas/HTTPValidationError"
282
- }
283
- }
284
- }
285
- }
286
- }
287
- }
288
- },
289
- "/images/{file_path}": {
290
- "get": {
291
- "tags": [
292
- "Images"
293
- ],
294
- "summary": "Serve image file",
295
- "description": "Serves the actual image file by path",
296
- "operationId": "serve_image_images__file_path__get",
297
- "parameters": [
298
- {
299
- "name": "file_path",
300
- "in": "path",
301
- "required": true,
302
- "schema": {
303
- "type": "string",
304
- "title": "File Path"
305
- }
306
- }
307
- ],
308
- "responses": {
309
- "200": {
310
- "description": "Successful Response",
311
- "content": {
312
- "application/json": {
313
- "schema": {}
314
- }
315
- }
316
- },
317
- "422": {
318
- "description": "Validation Error",
319
- "content": {
320
- "application/json": {
321
- "schema": {
322
- "$ref": "#/components/schemas/HTTPValidationError"
323
- }
324
- }
325
- }
326
- }
327
- }
328
- }
329
- },
330
- "/performance": {
331
- "get": {
332
- "tags": [
333
- "health"
334
- ],
335
- "summary": "check api os performance",
336
- "description": "check api os performance cpu, memory, disk",
337
- "operationId": "system_performance_performance_get",
338
- "responses": {
339
- "200": {
340
- "description": "Successful Response",
341
- "content": {
342
- "application/json": {
343
- "schema": {
344
- "$ref": "#/components/schemas/APIResponse"
345
- }
346
- }
347
- }
348
- }
349
- }
350
- }
351
- },
352
- "/healthcheck": {
353
- "get": {
354
- "tags": [
355
- "health"
356
- ],
357
- "summary": "check api health",
358
- "description": "check api health, returns ok 200 if healthy",
359
- "operationId": "system_health_healthcheck_get",
360
- "responses": {
361
- "200": {
362
- "description": "Successful Response",
363
- "content": {
364
- "application/json": {
365
- "schema": {
366
- "$ref": "#/components/schemas/APIResponse"
367
- }
368
- }
369
- }
370
- }
371
- }
372
- }
373
- },
374
- "/breed/{breed}/description": {
375
- "get": {
376
- "tags": [
377
- "Descriptions"
378
- ],
379
- "summary": "Get breed description",
380
- "description": "Returns the description for a specific breed in multiple languages",
381
- "operationId": "breed_description_breed__breed__description_get",
382
- "parameters": [
383
- {
384
- "name": "breed",
385
- "in": "path",
386
- "required": true,
387
- "schema": {
388
- "type": "string",
389
- "title": "Breed"
390
- }
391
- }
392
- ],
393
- "responses": {
394
- "200": {
395
- "description": "Successful Response",
396
- "content": {
397
- "application/json": {
398
- "schema": {
399
- "$ref": "#/components/schemas/APIResponse"
400
- }
401
- }
402
- }
403
- },
404
- "422": {
405
- "description": "Validation Error",
406
- "content": {
407
- "application/json": {
408
- "schema": {
409
- "$ref": "#/components/schemas/HTTPValidationError"
410
- }
411
- }
412
- }
413
- }
414
- }
415
- }
416
- },
417
- "/breed/{breed}/{variant}/description": {
418
- "get": {
419
- "tags": [
420
- "Descriptions"
421
- ],
422
- "summary": "Get variant description",
423
- "description": "Returns the description for a specific breed variant in multiple languages",
424
- "operationId": "variant_description_breed__breed___variant__description_get",
425
- "parameters": [
426
- {
427
- "name": "breed",
428
- "in": "path",
429
- "required": true,
430
- "schema": {
431
- "type": "string",
432
- "title": "Breed"
433
- }
434
- },
435
- {
436
- "name": "variant",
437
- "in": "path",
438
- "required": true,
439
- "schema": {
440
- "type": "string",
441
- "title": "Variant"
442
- }
443
- }
444
- ],
445
- "responses": {
446
- "200": {
447
- "description": "Successful Response",
448
- "content": {
449
- "application/json": {
450
- "schema": {
451
- "$ref": "#/components/schemas/APIResponse"
452
- }
453
- }
454
- }
455
- },
456
- "422": {
457
- "description": "Validation Error",
458
- "content": {
459
- "application/json": {
460
- "schema": {
461
- "$ref": "#/components/schemas/HTTPValidationError"
462
- }
463
- }
464
- }
465
- }
466
- }
467
- }
468
- }
469
- },
470
- "components": {
471
- "schemas": {
472
- "APIResponse": {
473
- "properties": {
474
- "status": {
475
- "$ref": "#/components/schemas/Status"
476
- },
477
- "message": {
478
- "anyOf": [
479
- {
480
- "additionalProperties": true,
481
- "type": "object"
482
- },
483
- {
484
- "items": {
485
- "type": "string"
486
- },
487
- "type": "array"
488
- },
489
- {
490
- "type": "string"
491
- }
492
- ],
493
- "title": "Message"
494
- }
495
- },
496
- "type": "object",
497
- "required": [
498
- "status",
499
- "message"
500
- ],
501
- "title": "APIResponse"
502
- },
503
- "HTTPValidationError": {
504
- "properties": {
505
- "detail": {
506
- "items": {
507
- "$ref": "#/components/schemas/ValidationError"
508
- },
509
- "type": "array",
510
- "title": "Detail"
511
- }
512
- },
513
- "type": "object",
514
- "title": "HTTPValidationError"
515
- },
516
- "Status": {
517
- "type": "string",
518
- "enum": [
519
- "success",
520
- "error"
521
- ],
522
- "title": "Status"
523
- },
524
- "ValidationError": {
525
- "properties": {
526
- "loc": {
527
- "items": {
528
- "anyOf": [
529
- {
530
- "type": "string"
531
- },
532
- {
533
- "type": "integer"
534
- }
535
- ]
536
- },
537
- "type": "array",
538
- "title": "Location"
539
- },
540
- "msg": {
541
- "type": "string",
542
- "title": "Message"
543
- },
544
- "type": {
545
- "type": "string",
546
- "title": "Error Type"
547
- }
548
- },
549
- "type": "object",
550
- "required": [
551
- "loc",
552
- "msg",
553
- "type"
554
- ],
555
- "title": "ValidationError"
556
- }
557
- }
558
- },
559
- "tags": [
560
- {
561
- "name": "Breeds",
562
- "description": "Operations related to dog breeds and sub-breeds"
563
- },
564
- {
565
- "name": "Images",
566
- "description": "Operations related to dog images"
567
- }
568
- ],
569
- "servers": [
570
- {
571
- "url": "http://localhost:8000",
572
- "description": "Local development server"
573
- }
574
- ]
1
+ {
2
+ "openapi": "3.1.0",
3
+ "info": {
4
+ "title": "dog-api",
5
+ "description": "API for accessing dog breed images and information",
6
+ "version": "1.0.0",
7
+ "contact": {
8
+ "name": "API Support"
9
+ }
10
+ },
11
+ "paths": {
12
+ "/breeds/list/all": {
13
+ "get": {
14
+ "tags": [
15
+ "Breeds"
16
+ ],
17
+ "summary": "List all breeds",
18
+ "description": "Returns a list of all available dog breeds and their sub-breeds",
19
+ "operationId": "list_all_breeds_breeds_list_all_get",
20
+ "responses": {
21
+ "200": {
22
+ "description": "Successful Response",
23
+ "content": {
24
+ "application/json": {
25
+ "schema": {
26
+ "$ref": "#/components/schemas/APIResponse_Dict_str__List_str___"
27
+ }
28
+ }
29
+ }
30
+ }
31
+ }
32
+ }
33
+ },
34
+ "/breed/{breed}/list": {
35
+ "get": {
36
+ "tags": [
37
+ "Breeds"
38
+ ],
39
+ "summary": "Get breed sub-breeds",
40
+ "description": "Returns a list of sub-breeds for a specific breed -",
41
+ "operationId": "breed_subbreeds_breed__breed__list_get",
42
+ "parameters": [
43
+ {
44
+ "name": "breed",
45
+ "in": "path",
46
+ "required": true,
47
+ "schema": {
48
+ "type": "string",
49
+ "title": "Breed"
50
+ }
51
+ }
52
+ ],
53
+ "responses": {
54
+ "200": {
55
+ "description": "Successful Response",
56
+ "content": {
57
+ "application/json": {
58
+ "schema": {
59
+ "$ref": "#/components/schemas/APIResponse_List_str__"
60
+ }
61
+ }
62
+ }
63
+ },
64
+ "422": {
65
+ "description": "Validation Error",
66
+ "content": {
67
+ "application/json": {
68
+ "schema": {
69
+ "$ref": "#/components/schemas/HTTPValidationError"
70
+ }
71
+ }
72
+ }
73
+ }
74
+ }
75
+ }
76
+ },
77
+ "/breeds/image/random": {
78
+ "get": {
79
+ "tags": [
80
+ "Images"
81
+ ],
82
+ "summary": "Get random image",
83
+ "description": "Returns a random dog image URL from all available breeds",
84
+ "operationId": "random_image_breeds_image_random_get",
85
+ "responses": {
86
+ "200": {
87
+ "description": "Successful Response",
88
+ "content": {
89
+ "application/json": {
90
+ "schema": {
91
+ "$ref": "#/components/schemas/APIResponse_str_"
92
+ }
93
+ }
94
+ }
95
+ }
96
+ }
97
+ }
98
+ },
99
+ "/breed/{breed}/images": {
100
+ "get": {
101
+ "tags": [
102
+ "Images"
103
+ ],
104
+ "summary": "Get breed images",
105
+ "description": "Returns all image URLs for a specific breed",
106
+ "operationId": "breed_images_breed__breed__images_get",
107
+ "parameters": [
108
+ {
109
+ "name": "breed",
110
+ "in": "path",
111
+ "required": true,
112
+ "schema": {
113
+ "type": "string",
114
+ "title": "Breed"
115
+ }
116
+ }
117
+ ],
118
+ "responses": {
119
+ "200": {
120
+ "description": "Successful Response",
121
+ "content": {
122
+ "application/json": {
123
+ "schema": {
124
+ "$ref": "#/components/schemas/APIResponse_List_str__"
125
+ }
126
+ }
127
+ }
128
+ },
129
+ "422": {
130
+ "description": "Validation Error",
131
+ "content": {
132
+ "application/json": {
133
+ "schema": {
134
+ "$ref": "#/components/schemas/HTTPValidationError"
135
+ }
136
+ }
137
+ }
138
+ }
139
+ }
140
+ }
141
+ },
142
+ "/breed/{breed}/images/random": {
143
+ "get": {
144
+ "tags": [
145
+ "Images"
146
+ ],
147
+ "summary": "Get random breed image",
148
+ "description": "Returns a random image URL for a specific breed",
149
+ "operationId": "random_breed_image_breed__breed__images_random_get",
150
+ "parameters": [
151
+ {
152
+ "name": "breed",
153
+ "in": "path",
154
+ "required": true,
155
+ "schema": {
156
+ "type": "string",
157
+ "title": "Breed"
158
+ }
159
+ }
160
+ ],
161
+ "responses": {
162
+ "200": {
163
+ "description": "Successful Response",
164
+ "content": {
165
+ "application/json": {
166
+ "schema": {
167
+ "$ref": "#/components/schemas/APIResponse_str_"
168
+ }
169
+ }
170
+ }
171
+ },
172
+ "422": {
173
+ "description": "Validation Error",
174
+ "content": {
175
+ "application/json": {
176
+ "schema": {
177
+ "$ref": "#/components/schemas/HTTPValidationError"
178
+ }
179
+ }
180
+ }
181
+ }
182
+ }
183
+ }
184
+ },
185
+ "/breed/{breed}/{subbreed}/images": {
186
+ "get": {
187
+ "tags": [
188
+ "Images"
189
+ ],
190
+ "summary": "Get sub-breed images",
191
+ "description": "Returns all image URLs for a specific sub-breed",
192
+ "operationId": "subbreed_images_breed__breed___subbreed__images_get",
193
+ "parameters": [
194
+ {
195
+ "name": "breed",
196
+ "in": "path",
197
+ "required": true,
198
+ "schema": {
199
+ "type": "string",
200
+ "title": "Breed"
201
+ }
202
+ },
203
+ {
204
+ "name": "subbreed",
205
+ "in": "path",
206
+ "required": true,
207
+ "schema": {
208
+ "type": "string",
209
+ "title": "Subbreed"
210
+ }
211
+ }
212
+ ],
213
+ "responses": {
214
+ "200": {
215
+ "description": "Successful Response",
216
+ "content": {
217
+ "application/json": {
218
+ "schema": {
219
+ "$ref": "#/components/schemas/APIResponse_List_str__"
220
+ }
221
+ }
222
+ }
223
+ },
224
+ "422": {
225
+ "description": "Validation Error",
226
+ "content": {
227
+ "application/json": {
228
+ "schema": {
229
+ "$ref": "#/components/schemas/HTTPValidationError"
230
+ }
231
+ }
232
+ }
233
+ }
234
+ }
235
+ }
236
+ },
237
+ "/breed/{breed}/{subbreed}/images/random": {
238
+ "get": {
239
+ "tags": [
240
+ "Images"
241
+ ],
242
+ "summary": "Get random sub-breed image",
243
+ "description": "Returns a random image URL for a specific sub-breed",
244
+ "operationId": "random_subbreed_image_breed__breed___subbreed__images_random_get",
245
+ "parameters": [
246
+ {
247
+ "name": "breed",
248
+ "in": "path",
249
+ "required": true,
250
+ "schema": {
251
+ "type": "string",
252
+ "title": "Breed"
253
+ }
254
+ },
255
+ {
256
+ "name": "subbreed",
257
+ "in": "path",
258
+ "required": true,
259
+ "schema": {
260
+ "type": "string",
261
+ "title": "Subbreed"
262
+ }
263
+ }
264
+ ],
265
+ "responses": {
266
+ "200": {
267
+ "description": "Successful Response",
268
+ "content": {
269
+ "application/json": {
270
+ "schema": {
271
+ "$ref": "#/components/schemas/APIResponse_str_"
272
+ }
273
+ }
274
+ }
275
+ },
276
+ "422": {
277
+ "description": "Validation Error",
278
+ "content": {
279
+ "application/json": {
280
+ "schema": {
281
+ "$ref": "#/components/schemas/HTTPValidationError"
282
+ }
283
+ }
284
+ }
285
+ }
286
+ }
287
+ }
288
+ },
289
+ "/images/{file_path}": {
290
+ "get": {
291
+ "tags": [
292
+ "Images"
293
+ ],
294
+ "summary": "Serve image file",
295
+ "description": "Serves the actual image file by path",
296
+ "operationId": "serve_image_images__file_path__get",
297
+ "parameters": [
298
+ {
299
+ "name": "file_path",
300
+ "in": "path",
301
+ "required": true,
302
+ "schema": {
303
+ "type": "string",
304
+ "title": "File Path"
305
+ }
306
+ }
307
+ ],
308
+ "responses": {
309
+ "200": {
310
+ "description": "Successful Response",
311
+ "content": {
312
+ "application/json": {
313
+ "schema": {}
314
+ }
315
+ }
316
+ },
317
+ "422": {
318
+ "description": "Validation Error",
319
+ "content": {
320
+ "application/json": {
321
+ "schema": {
322
+ "$ref": "#/components/schemas/HTTPValidationError"
323
+ }
324
+ }
325
+ }
326
+ }
327
+ }
328
+ }
329
+ },
330
+ "/performance": {
331
+ "get": {
332
+ "tags": [
333
+ "health"
334
+ ],
335
+ "summary": "check api os performance",
336
+ "description": "check api os performance cpu, memory, disk",
337
+ "operationId": "system_performance_performance_get",
338
+ "responses": {
339
+ "200": {
340
+ "description": "Successful Response",
341
+ "content": {
342
+ "application/json": {
343
+ "schema": {
344
+ "$ref": "#/components/schemas/APIResponse_PerformanceMessage_"
345
+ }
346
+ }
347
+ }
348
+ }
349
+ }
350
+ }
351
+ },
352
+ "/healthcheck": {
353
+ "get": {
354
+ "tags": [
355
+ "health"
356
+ ],
357
+ "summary": "check api health",
358
+ "description": "check api health, returns ok 200 if healthy",
359
+ "operationId": "system_health_healthcheck_get",
360
+ "responses": {
361
+ "200": {
362
+ "description": "Successful Response",
363
+ "content": {
364
+ "application/json": {
365
+ "schema": {
366
+ "$ref": "#/components/schemas/APIResponse_str_"
367
+ }
368
+ }
369
+ }
370
+ }
371
+ }
372
+ }
373
+ },
374
+ "/breed/{breed}/description": {
375
+ "get": {
376
+ "tags": [
377
+ "Descriptions"
378
+ ],
379
+ "summary": "Get breed description",
380
+ "description": "Returns the description for a specific breed in multiple languages",
381
+ "operationId": "breed_description_breed__breed__description_get",
382
+ "parameters": [
383
+ {
384
+ "name": "breed",
385
+ "in": "path",
386
+ "required": true,
387
+ "schema": {
388
+ "type": "string",
389
+ "title": "Breed"
390
+ }
391
+ }
392
+ ],
393
+ "responses": {
394
+ "200": {
395
+ "description": "Successful Response",
396
+ "content": {
397
+ "application/json": {
398
+ "schema": {
399
+ "$ref": "#/components/schemas/APIResponse_DescriptionMessage_"
400
+ }
401
+ }
402
+ }
403
+ },
404
+ "422": {
405
+ "description": "Validation Error",
406
+ "content": {
407
+ "application/json": {
408
+ "schema": {
409
+ "$ref": "#/components/schemas/HTTPValidationError"
410
+ }
411
+ }
412
+ }
413
+ }
414
+ }
415
+ }
416
+ },
417
+ "/breed/{breed}/{variant}/description": {
418
+ "get": {
419
+ "tags": [
420
+ "Descriptions"
421
+ ],
422
+ "summary": "Get variant description",
423
+ "description": "Returns the description for a specific breed variant in multiple languages",
424
+ "operationId": "variant_description_breed__breed___variant__description_get",
425
+ "parameters": [
426
+ {
427
+ "name": "breed",
428
+ "in": "path",
429
+ "required": true,
430
+ "schema": {
431
+ "type": "string",
432
+ "title": "Breed"
433
+ }
434
+ },
435
+ {
436
+ "name": "variant",
437
+ "in": "path",
438
+ "required": true,
439
+ "schema": {
440
+ "type": "string",
441
+ "title": "Variant"
442
+ }
443
+ }
444
+ ],
445
+ "responses": {
446
+ "200": {
447
+ "description": "Successful Response",
448
+ "content": {
449
+ "application/json": {
450
+ "schema": {
451
+ "$ref": "#/components/schemas/APIResponse_DescriptionMessage_"
452
+ }
453
+ }
454
+ }
455
+ },
456
+ "422": {
457
+ "description": "Validation Error",
458
+ "content": {
459
+ "application/json": {
460
+ "schema": {
461
+ "$ref": "#/components/schemas/HTTPValidationError"
462
+ }
463
+ }
464
+ }
465
+ }
466
+ }
467
+ }
468
+ }
469
+ },
470
+ "components": {
471
+ "schemas": {
472
+ "APIResponse_DescriptionMessage_": {
473
+ "properties": {
474
+ "status": {
475
+ "$ref": "#/components/schemas/Status"
476
+ },
477
+ "message": {
478
+ "$ref": "#/components/schemas/DescriptionMessage"
479
+ }
480
+ },
481
+ "type": "object",
482
+ "required": [
483
+ "status",
484
+ "message"
485
+ ],
486
+ "title": "APIResponse[DescriptionMessage]"
487
+ },
488
+ "APIResponse_Dict_str__List_str___": {
489
+ "properties": {
490
+ "status": {
491
+ "$ref": "#/components/schemas/Status"
492
+ },
493
+ "message": {
494
+ "additionalProperties": {
495
+ "items": {
496
+ "type": "string"
497
+ },
498
+ "type": "array"
499
+ },
500
+ "type": "object",
501
+ "title": "Message"
502
+ }
503
+ },
504
+ "type": "object",
505
+ "required": [
506
+ "status",
507
+ "message"
508
+ ],
509
+ "title": "APIResponse[Dict[str, List[str]]]"
510
+ },
511
+ "APIResponse_List_str__": {
512
+ "properties": {
513
+ "status": {
514
+ "$ref": "#/components/schemas/Status"
515
+ },
516
+ "message": {
517
+ "items": {
518
+ "type": "string"
519
+ },
520
+ "type": "array",
521
+ "title": "Message"
522
+ }
523
+ },
524
+ "type": "object",
525
+ "required": [
526
+ "status",
527
+ "message"
528
+ ],
529
+ "title": "APIResponse[List[str]]"
530
+ },
531
+ "APIResponse_PerformanceMessage_": {
532
+ "properties": {
533
+ "status": {
534
+ "$ref": "#/components/schemas/Status"
535
+ },
536
+ "message": {
537
+ "$ref": "#/components/schemas/PerformanceMessage"
538
+ }
539
+ },
540
+ "type": "object",
541
+ "required": [
542
+ "status",
543
+ "message"
544
+ ],
545
+ "title": "APIResponse[PerformanceMessage]"
546
+ },
547
+ "APIResponse_str_": {
548
+ "properties": {
549
+ "status": {
550
+ "$ref": "#/components/schemas/Status"
551
+ },
552
+ "message": {
553
+ "type": "string",
554
+ "title": "Message"
555
+ }
556
+ },
557
+ "type": "object",
558
+ "required": [
559
+ "status",
560
+ "message"
561
+ ],
562
+ "title": "APIResponse[str]"
563
+ },
564
+ "DescriptionMessage": {
565
+ "properties": {
566
+ "breed": {
567
+ "type": "string",
568
+ "title": "Breed"
569
+ },
570
+ "variant": {
571
+ "anyOf": [
572
+ {
573
+ "type": "string"
574
+ },
575
+ {
576
+ "type": "null"
577
+ }
578
+ ],
579
+ "title": "Variant"
580
+ },
581
+ "description_en": {
582
+ "type": "string",
583
+ "title": "Description En"
584
+ },
585
+ "description_pl": {
586
+ "type": "string",
587
+ "title": "Description Pl"
588
+ }
589
+ },
590
+ "type": "object",
591
+ "required": [
592
+ "breed",
593
+ "description_en",
594
+ "description_pl"
595
+ ],
596
+ "title": "DescriptionMessage"
597
+ },
598
+ "HTTPValidationError": {
599
+ "properties": {
600
+ "detail": {
601
+ "items": {
602
+ "$ref": "#/components/schemas/ValidationError"
603
+ },
604
+ "type": "array",
605
+ "title": "Detail"
606
+ }
607
+ },
608
+ "type": "object",
609
+ "title": "HTTPValidationError"
610
+ },
611
+ "PerformanceMessage": {
612
+ "properties": {
613
+ "cpu_usage": {
614
+ "type": "string",
615
+ "title": "Cpu Usage"
616
+ },
617
+ "memory_usage": {
618
+ "type": "string",
619
+ "title": "Memory Usage"
620
+ },
621
+ "disk_usage": {
622
+ "type": "string",
623
+ "title": "Disk Usage"
624
+ },
625
+ "thread_count": {
626
+ "type": "integer",
627
+ "title": "Thread Count"
628
+ },
629
+ "uptime_seconds": {
630
+ "type": "number",
631
+ "title": "Uptime Seconds"
632
+ }
633
+ },
634
+ "type": "object",
635
+ "required": [
636
+ "cpu_usage",
637
+ "memory_usage",
638
+ "disk_usage",
639
+ "thread_count",
640
+ "uptime_seconds"
641
+ ],
642
+ "title": "PerformanceMessage"
643
+ },
644
+ "Status": {
645
+ "type": "string",
646
+ "enum": [
647
+ "success",
648
+ "error"
649
+ ],
650
+ "title": "Status"
651
+ },
652
+ "ValidationError": {
653
+ "properties": {
654
+ "loc": {
655
+ "items": {
656
+ "anyOf": [
657
+ {
658
+ "type": "string"
659
+ },
660
+ {
661
+ "type": "integer"
662
+ }
663
+ ]
664
+ },
665
+ "type": "array",
666
+ "title": "Location"
667
+ },
668
+ "msg": {
669
+ "type": "string",
670
+ "title": "Message"
671
+ },
672
+ "type": {
673
+ "type": "string",
674
+ "title": "Error Type"
675
+ }
676
+ },
677
+ "type": "object",
678
+ "required": [
679
+ "loc",
680
+ "msg",
681
+ "type"
682
+ ],
683
+ "title": "ValidationError"
684
+ }
685
+ }
686
+ },
687
+ "tags": [
688
+ {
689
+ "name": "Breeds",
690
+ "description": "Operations related to dog breeds and sub-breeds"
691
+ },
692
+ {
693
+ "name": "Images",
694
+ "description": "Operations related to dog images"
695
+ }
696
+ ],
697
+ "servers": [
698
+ {
699
+ "url": "/dog-api",
700
+ "description": "Local development server"
701
+ }
702
+ ]
575
703
  }