From 9bd863c3f9c4b6883e0937007da8f8188c75dd5d Mon Sep 17 00:00:00 2001 From: kbeaugrand <9513635+kbeaugrand@users.noreply.github.com> Date: Sun, 25 Feb 2024 06:35:32 +0000 Subject: [PATCH] Adds auto-generated Open API doc. --- docs/swagger.json | 324 ++++++++++++++++++++-------------------------- 1 file changed, 142 insertions(+), 182 deletions(-) diff --git a/docs/swagger.json b/docs/swagger.json index 58376e752..6479a4000 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -188,6 +188,36 @@ "description": "Success" } } + }, + "put": { + "tags": [ + "IoT Devices" + ], + "operationId": "PUT Update Device configuration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeviceConfig" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DeviceConfig" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DeviceConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } } }, "/api/device-configurations/{configurationId}": { @@ -229,46 +259,6 @@ } } }, - "put": { - "tags": [ - "IoT Devices" - ], - "operationId": "PUT Update Device configuration", - "parameters": [ - { - "name": "configurationId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceConfig" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DeviceConfig" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/DeviceConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Success" - } - } - }, "delete": { "tags": [ "IoT Devices" @@ -926,6 +916,38 @@ } } } + }, + "put": { + "tags": [ + "IoT Edge Devices" + ], + "summary": "Updates the device.", + "operationId": "PUT Update IoT Edge", + "requestBody": { + "description": "The IoT Edge device.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IoTEdgeDevice" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/IoTEdgeDevice" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/IoTEdgeDevice" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } } }, "/api/edge/devices/{deviceId}": { @@ -969,48 +991,6 @@ } } }, - "put": { - "tags": [ - "IoT Edge Devices" - ], - "summary": "Updates the device.", - "operationId": "PUT Update IoT Edge", - "parameters": [ - { - "name": "deviceId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The IoT Edge device.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IoTEdgeDevice" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/IoTEdgeDevice" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/IoTEdgeDevice" - } - } - } - }, - "responses": { - "200": { - "description": "Success" - } - } - }, "delete": { "tags": [ "IoT Edge Devices" @@ -2603,43 +2583,53 @@ } } } - } - }, - "/api/lorawan/models/{id}": { - "get": { + }, + "put": { "tags": [ "LoRa WAN" ], - "summary": "Get the device model details.", - "operationId": "GET LoRaWAN device model", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The devic emodel identifier.", - "required": true, - "schema": { - "type": "string" + "summary": "Updates the specified device model.", + "operationId": "PUT Update the LoRaWAN device model", + "requestBody": { + "description": "The device model.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LoRaDeviceModelDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/LoRaDeviceModelDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/LoRaDeviceModelDto" + } } } - ], + }, "responses": { "200": { - "description": "Success", + "description": "Success" + }, + "400": { + "description": "Bad Request", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/LoRaDeviceModelDto" + "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/LoRaDeviceModelDto" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/LoRaDeviceModelDto" + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -2665,63 +2655,43 @@ } } } - }, - "put": { + } + }, + "/api/lorawan/models/{id}": { + "get": { "tags": [ "LoRa WAN" ], - "summary": "Updates the specified device model.", - "operationId": "PUT Update the LoRaWAN device model", + "summary": "Get the device model details.", + "operationId": "GET LoRaWAN device model", "parameters": [ { "name": "id", "in": "path", + "description": "The devic emodel identifier.", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "description": "The device model.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LoRaDeviceModelDto" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/LoRaDeviceModelDto" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/LoRaDeviceModelDto" - } - } - } - }, "responses": { "200": { - "description": "Success" - }, - "400": { - "description": "Bad Request", + "description": "Success", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/LoRaDeviceModelDto" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/LoRaDeviceModelDto" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/LoRaDeviceModelDto" } } } @@ -3216,43 +3186,53 @@ } } } - } - }, - "/api/models/{id}": { - "get": { + }, + "put": { "tags": [ "Device Models" ], - "summary": "Get the device model details.", - "operationId": "GET Device model", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The devic emodel identifier.", - "required": true, - "schema": { - "type": "string" + "summary": "Updates the specified device model.", + "operationId": "PUT Update the device model", + "requestBody": { + "description": "The device model.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeviceModelDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DeviceModelDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DeviceModelDto" + } } } - ], + }, "responses": { "200": { - "description": "Success", + "description": "Success" + }, + "400": { + "description": "Bad Request", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/DeviceModelDto" + "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeviceModelDto" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/DeviceModelDto" + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -3278,63 +3258,43 @@ } } } - }, - "put": { + } + }, + "/api/models/{id}": { + "get": { "tags": [ "Device Models" ], - "summary": "Updates the specified device model.", - "operationId": "PUT Update the device model", + "summary": "Get the device model details.", + "operationId": "GET Device model", "parameters": [ { "name": "id", "in": "path", + "description": "The devic emodel identifier.", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "description": "The device model.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceModelDto" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DeviceModelDto" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/DeviceModelDto" - } - } - } - }, "responses": { "200": { - "description": "Success" - }, - "400": { - "description": "Bad Request", + "description": "Success", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/DeviceModelDto" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/DeviceModelDto" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/DeviceModelDto" } } }