-
Notifications
You must be signed in to change notification settings - Fork 2
Documentation: Device Manager
David edited this page May 21, 2023
·
1 revision
Readiness
Readiness health endpoint.
Inspects sqlalchemy engine and check if workflow table exists.
Status docstring
HTTPException 500: Workflow table not found
Code | Description |
---|---|
200 | Successful Response |
Get Devices
Get all devices endpoint.
List of device pydantic output models
Code | Description |
---|---|
200 | Successful Response |
Create Device
Create new device endpoint.
payload Device pydantic base model
Device pydantic output model
HTTPException 404: Creation unsuccessful
Code | Description |
---|---|
201 | Successful Response |
422 | Validation Error |
Get Device
Get device endpoint.
device_id Id of requested device
Device pydantic output model
HTTPException 404: Not found
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
device_id | path | Yes | integer |
Code | Description |
---|---|
200 | Successful Response |
422 | Validation Error |
Update Device
Update device endpoint.
device_id Id of device to be updated payload New device pydantic base model, contains new data
Updated device pydantic output model
HTTPException 404: Not found
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
device_id | path | Yes | integer |
Code | Description |
---|---|
200 | Successful Response |
422 | Validation Error |
Delete Device
Delete device endpoint.
id Id of device to be deleted
HTTPException 404: Not found
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
device_id | path | Yes | integer |
Code | Description |
---|---|
204 | Successful Response |
422 | Validation Error |