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 #1798

Merged
merged 1 commit into from
Feb 23, 2023
Merged

Update API documentation #1798

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
125 changes: 101 additions & 24 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
Expand Down Expand Up @@ -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"
}
}
}
Expand Down Expand Up @@ -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",
Expand Down