Skip to content

Commit

Permalink
chore: update state endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickgell committed Dec 5, 2023
1 parent 002ad59 commit d81491b
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
23 changes: 23 additions & 0 deletions openapi/MainResources-local-openapi-v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,29 @@ paths:
schema:
$ref: '#/components/schemas/AdvancedError'
'/userdefinedstates/{userDefinedStateId}/state':
get:
summary: Retrieve the state of a specific UserDefinedState
description: |-
Retrieves the state of a UserDefinedState on the controller identified by the `userDefinedStateId` path parameter.
tags:
- UserDefinedStates
parameters:
- $ref: '#/components/parameters/apiVersionHeaderParam'
- $ref: '#/components/parameters/userDefinedStateIdPathParam'
responses:
'200':
description: Accepted request.
content:
text/plain:
schema:
type: string
example: true
'404':
description: The entity could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
put:
summary: Executes the state on the controller
description: |-
Expand Down
19 changes: 19 additions & 0 deletions postman/Bosch Smart Home Controller.postman_collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -632,6 +632,25 @@
},
"response": []
},
{
"name": "State of UserDefinedState by Id",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{shc_api}}/userdefinedstates/{{user_defined_state_id}}/state",
"host": [
"{{shc_api}}"
],
"path": [
"userdefinedstates",
"{{user_defined_state_id}}",
"state"
]
}
},
"response": []
},
{
"name": "UserDefinedState",
"request": {
Expand Down

0 comments on commit d81491b

Please sign in to comment.