Skip to content

Commit 3577938

Browse files
committed
update openapi spes
1 parent 044199e commit 3577938

File tree

1 file changed

+220
-0
lines changed

1 file changed

+220
-0
lines changed

services/api-server/openapi.json

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5348,6 +5348,118 @@
53485348
}
53495349
]
53505350
}
5351+
},
5352+
"/v0/licensed-items/page": {
5353+
"get": {
5354+
"tags": [
5355+
"licensed-items"
5356+
],
5357+
"summary": "Get Licensed Items",
5358+
"description": "Get all licensed items",
5359+
"operationId": "get_licensed_items",
5360+
"security": [
5361+
{
5362+
"HTTPBasic": []
5363+
}
5364+
],
5365+
"parameters": [
5366+
{
5367+
"name": "limit",
5368+
"in": "query",
5369+
"required": false,
5370+
"schema": {
5371+
"type": "integer",
5372+
"maximum": 100,
5373+
"minimum": 1,
5374+
"default": 50,
5375+
"title": "Limit"
5376+
}
5377+
},
5378+
{
5379+
"name": "offset",
5380+
"in": "query",
5381+
"required": false,
5382+
"schema": {
5383+
"type": "integer",
5384+
"minimum": 0,
5385+
"default": 0,
5386+
"title": "Offset"
5387+
}
5388+
}
5389+
],
5390+
"responses": {
5391+
"200": {
5392+
"description": "Successful Response",
5393+
"content": {
5394+
"application/json": {
5395+
"schema": {
5396+
"$ref": "#/components/schemas/Page_LicensedItemGet_"
5397+
}
5398+
}
5399+
}
5400+
},
5401+
"429": {
5402+
"description": "Too many requests",
5403+
"content": {
5404+
"application/json": {
5405+
"schema": {
5406+
"$ref": "#/components/schemas/ErrorGet"
5407+
}
5408+
}
5409+
}
5410+
},
5411+
"500": {
5412+
"description": "Internal server error",
5413+
"content": {
5414+
"application/json": {
5415+
"schema": {
5416+
"$ref": "#/components/schemas/ErrorGet"
5417+
}
5418+
}
5419+
}
5420+
},
5421+
"502": {
5422+
"description": "Unexpected error when communicating with backend service",
5423+
"content": {
5424+
"application/json": {
5425+
"schema": {
5426+
"$ref": "#/components/schemas/ErrorGet"
5427+
}
5428+
}
5429+
}
5430+
},
5431+
"503": {
5432+
"description": "Service unavailable",
5433+
"content": {
5434+
"application/json": {
5435+
"schema": {
5436+
"$ref": "#/components/schemas/ErrorGet"
5437+
}
5438+
}
5439+
}
5440+
},
5441+
"504": {
5442+
"description": "Request to a backend service timed out.",
5443+
"content": {
5444+
"application/json": {
5445+
"schema": {
5446+
"$ref": "#/components/schemas/ErrorGet"
5447+
}
5448+
}
5449+
}
5450+
},
5451+
"422": {
5452+
"description": "Validation Error",
5453+
"content": {
5454+
"application/json": {
5455+
"schema": {
5456+
"$ref": "#/components/schemas/HTTPValidationError"
5457+
}
5458+
}
5459+
}
5460+
}
5461+
}
5462+
}
53515463
}
53525464
},
53535465
"components": {
@@ -6086,6 +6198,55 @@
60866198
"submitted_at": "2021-04-01 07:15:54.631007"
60876199
}
60886200
},
6201+
"LicensedItemGet": {
6202+
"properties": {
6203+
"licensed_item_id": {
6204+
"type": "string",
6205+
"format": "uuid",
6206+
"title": "Licensed Item Id"
6207+
},
6208+
"name": {
6209+
"type": "string",
6210+
"title": "Name"
6211+
},
6212+
"licensed_resource_type": {
6213+
"$ref": "#/components/schemas/LicensedResourceType"
6214+
},
6215+
"pricing_plan_id": {
6216+
"type": "integer",
6217+
"exclusiveMinimum": true,
6218+
"title": "Pricing Plan Id",
6219+
"minimum": 0
6220+
},
6221+
"created_at": {
6222+
"type": "string",
6223+
"format": "date-time",
6224+
"title": "Created At"
6225+
},
6226+
"modified_at": {
6227+
"type": "string",
6228+
"format": "date-time",
6229+
"title": "Modified At"
6230+
}
6231+
},
6232+
"type": "object",
6233+
"required": [
6234+
"licensed_item_id",
6235+
"name",
6236+
"licensed_resource_type",
6237+
"pricing_plan_id",
6238+
"created_at",
6239+
"modified_at"
6240+
],
6241+
"title": "LicensedItemGet"
6242+
},
6243+
"LicensedResourceType": {
6244+
"type": "string",
6245+
"enum": [
6246+
"VIP_MODEL"
6247+
],
6248+
"title": "LicensedResourceType"
6249+
},
60896250
"Links": {
60906251
"properties": {
60916252
"first": {
@@ -6409,6 +6570,65 @@
64096570
],
64106571
"title": "Page[Job]"
64116572
},
6573+
"Page_LicensedItemGet_": {
6574+
"properties": {
6575+
"items": {
6576+
"items": {
6577+
"$ref": "#/components/schemas/LicensedItemGet"
6578+
},
6579+
"type": "array",
6580+
"title": "Items"
6581+
},
6582+
"total": {
6583+
"anyOf": [
6584+
{
6585+
"type": "integer",
6586+
"minimum": 0
6587+
},
6588+
{
6589+
"type": "null"
6590+
}
6591+
],
6592+
"title": "Total"
6593+
},
6594+
"limit": {
6595+
"anyOf": [
6596+
{
6597+
"type": "integer",
6598+
"minimum": 1
6599+
},
6600+
{
6601+
"type": "null"
6602+
}
6603+
],
6604+
"title": "Limit"
6605+
},
6606+
"offset": {
6607+
"anyOf": [
6608+
{
6609+
"type": "integer",
6610+
"minimum": 0
6611+
},
6612+
{
6613+
"type": "null"
6614+
}
6615+
],
6616+
"title": "Offset"
6617+
},
6618+
"links": {
6619+
"$ref": "#/components/schemas/Links"
6620+
}
6621+
},
6622+
"type": "object",
6623+
"required": [
6624+
"items",
6625+
"total",
6626+
"limit",
6627+
"offset",
6628+
"links"
6629+
],
6630+
"title": "Page[LicensedItemGet]"
6631+
},
64126632
"Page_Study_": {
64136633
"properties": {
64146634
"items": {

0 commit comments

Comments
 (0)