diff --git a/OPENAPI_DOC.yml b/OPENAPI_DOC.yml index c9138e9f..dc62340d 100644 --- a/OPENAPI_DOC.yml +++ b/OPENAPI_DOC.yml @@ -12823,6 +12823,113 @@ paths: application/json: schema: $ref: '#/components/schemas/PlaceOS.Api.Application.ContentError' + /api/engine/v2/modules/{id}/state/{key}/value: + summary: Modules, running instances of drivers that control individual devices + and services + get: + summary: Returns the value of the requested status variable as JSON, `null` + when it isn't set. + description: 'Returns the value of the requested status variable as JSON, `null` + when it isn''t set. + + Subscribe to the resource to be notified when the value changes' + tags: + - Modules + operationId: PlaceOS::Api::Modules_state_value + parameters: + - name: id + in: path + required: true + schema: + type: string + - name: key + in: path + description: the name of the status variable + example: power + required: true + schema: + type: string + responses: + "200": + description: OK + "409": + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.CommonError' + "401": + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.CommonError' + "503": + description: Service Unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.ImageGenError' + "403": + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.ImageGenError' + "404": + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.CommonError' + "429": + description: Too Many Requests + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.ImageGenError' + "422": + description: Unprocessable Entity + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.ParameterError' + "502": + description: Bad Gateway + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.CommonError' + "504": + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.CommonError' + "406": + description: Not Acceptable + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.ContentError' + "408": + description: Request Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.CommonError' + "400": + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.ParameterError' + "415": + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/PlaceOS.Api.Application.ContentError' /api/engine/v2/modules/{id}/state/{key}: summary: Modules, running instances of drivers that control individual devices and services @@ -12928,6 +13035,124 @@ paths: application/json: schema: $ref: '#/components/schemas/PlaceOS.Api.Application.ContentError' + /api/engine/v2/modules/{id}/logs: + summary: Modules, running instances of drivers that control individual devices + and services + get: + summary: Captures the module's debug output for a period of time, as lines of + description: 'Captures the module''s debug output for a period of time, as lines + of + + `