Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update API documentation #1244

Merged
merged 1 commit into from
Sep 16, 2022
Merged

Update API documentation #1244

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 71 additions & 71 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1975,23 +1975,23 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
}
}
Expand All @@ -2010,17 +2010,17 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoRaDeviceModel"
"$ref": "#/components/schemas/LoRaDeviceModelDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LoRaDeviceModel"
"$ref": "#/components/schemas/LoRaDeviceModelDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/LoRaDeviceModel"
"$ref": "#/components/schemas/LoRaDeviceModelDto"
}
}
}
Expand Down Expand Up @@ -2077,17 +2077,17 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LoRaDeviceModel"
"$ref": "#/components/schemas/LoRaDeviceModelDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoRaDeviceModel"
"$ref": "#/components/schemas/LoRaDeviceModelDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LoRaDeviceModel"
"$ref": "#/components/schemas/LoRaDeviceModelDto"
}
}
}
Expand Down Expand Up @@ -2136,17 +2136,17 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoRaDeviceModel"
"$ref": "#/components/schemas/LoRaDeviceModelDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LoRaDeviceModel"
"$ref": "#/components/schemas/LoRaDeviceModelDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/LoRaDeviceModel"
"$ref": "#/components/schemas/LoRaDeviceModelDto"
}
}
}
Expand Down Expand Up @@ -2476,23 +2476,23 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModelCommand"
"$ref": "#/components/schemas/DeviceModelCommandDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModelCommand"
"$ref": "#/components/schemas/DeviceModelCommandDto"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModelCommand"
"$ref": "#/components/schemas/DeviceModelCommandDto"
}
}
}
Expand Down Expand Up @@ -2530,23 +2530,23 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModelCommand"
"$ref": "#/components/schemas/DeviceModelCommandDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModelCommand"
"$ref": "#/components/schemas/DeviceModelCommandDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModelCommand"
"$ref": "#/components/schemas/DeviceModelCommandDto"
}
}
}
Expand All @@ -2570,23 +2570,23 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
}
}
Expand All @@ -2605,17 +2605,17 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
}
}
Expand Down Expand Up @@ -2672,17 +2672,17 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
}
}
Expand Down Expand Up @@ -2731,17 +2731,17 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeviceModel"
"$ref": "#/components/schemas/DeviceModelDto"
}
}
}
Expand Down Expand Up @@ -3770,46 +3770,7 @@
"additionalProperties": false,
"description": "Class representing the page results."
},
"DeviceModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"modelId": {
"type": "string",
"description": "The device model identifier.",
"nullable": true
},
"imageUrl": {
"type": "string",
"description": "The device model image Url.",
"format": "uri",
"nullable": true
},
"name": {
"minLength": 1,
"type": "string",
"description": "The device model name."
},
"description": {
"type": "string",
"description": "The device model description.",
"nullable": true
},
"isBuiltin": {
"type": "boolean",
"description": "A value indicating whether this instance is builtin."
},
"supportLoRaFeatures": {
"type": "boolean",
"description": "A value indicating whether the LoRa features is supported on this model."
}
},
"additionalProperties": false,
"description": "Device model."
},
"DeviceModelCommand": {
"DeviceModelCommandDto": {
"required": [
"frame",
"name",
Expand Down Expand Up @@ -3848,6 +3809,45 @@
"additionalProperties": false,
"description": "Device model command."
},
"DeviceModelDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"modelId": {
"type": "string",
"description": "The device model identifier.",
"nullable": true
},
"imageUrl": {
"type": "string",
"description": "The device model image Url.",
"format": "uri",
"nullable": true
},
"name": {
"minLength": 1,
"type": "string",
"description": "The device model name."
},
"description": {
"type": "string",
"description": "The device model description.",
"nullable": true
},
"isBuiltin": {
"type": "boolean",
"description": "A value indicating whether this instance is builtin."
},
"supportLoRaFeatures": {
"type": "boolean",
"description": "A value indicating whether the LoRa features is supported on this model."
}
},
"additionalProperties": false,
"description": "Device model."
},
"DeviceProperty": {
"required": [
"displayName",
Expand Down Expand Up @@ -4642,7 +4642,7 @@
"additionalProperties": false,
"description": "LoRa WAN Device details."
},
"LoRaDeviceModel": {
"LoRaDeviceModelDto": {
"required": [
"name"
],
Expand Down