From fe26f1bc4296265daa24397e791385f3389b3dc3 Mon Sep 17 00:00:00 2001 From: kbeaugrand Date: Thu, 23 Feb 2023 16:21:04 +0000 Subject: [PATCH] Adds auto-generated Open API doc. --- docs/swagger.json | 125 +++++++++++++++++++++++++++++++++++++--------- 1 file changed, 101 insertions(+), 24 deletions(-) diff --git a/docs/swagger.json b/docs/swagger.json index 250909e79..8f20290e2 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -2344,32 +2344,58 @@ ], "summary": "Gets the device model list.", "operationId": "GET LoRaWAN device model list", + "parameters": [ + { + "name": "searchText", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "orderBy", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceModelDto" - } + "$ref": "#/components/schemas/DeviceModelDtoPaginationResult" } }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceModelDto" - } + "$ref": "#/components/schemas/DeviceModelDtoPaginationResult" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceModelDto" - } + "$ref": "#/components/schemas/DeviceModelDtoPaginationResult" } } } @@ -2931,32 +2957,58 @@ ], "summary": "Gets the device model list.", "operationId": "GET Device model list", + "parameters": [ + { + "name": "searchText", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "orderBy", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceModelDto" - } + "$ref": "#/components/schemas/DeviceModelDtoPaginationResult" } }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceModelDto" - } + "$ref": "#/components/schemas/DeviceModelDtoPaginationResult" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceModelDto" - } + "$ref": "#/components/schemas/DeviceModelDtoPaginationResult" } } } @@ -4246,6 +4298,31 @@ "additionalProperties": false, "description": "Device model." }, + "DeviceModelDtoPaginationResult": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceModelDto" + }, + "description": "The current page items.", + "nullable": true + }, + "totalItems": { + "type": "integer", + "description": "The total number of items.", + "format": "int32" + }, + "nextPage": { + "type": "string", + "description": "The query next page Url.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Class representing the page results." + }, "DeviceProperty": { "required": [ "displayName",