Skip to content

Commit

Permalink
Issue #106 minor fixes
Browse files Browse the repository at this point in the history
* typos
* add additional usage description for PUT /things resource

Signed-off-by: Joel Bartelheimer <joel.bartelheimer@bosch.io>
  • Loading branch information
jbartelh committed Nov 19, 2021
1 parent 93d147a commit f38c5d4
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ in: query
description: |-
Defines to which channel to route the command: `twin` (digital twin) or `live` (the device).
* If setting the channel parameter is omitted, the `twin` channel is set by default and the command is routed to the digital representation of a thing in Bosch IoT Things backend.
* When using the `live` channel, the command/message is send towards the device.
* When using the `live` channel, the command/message is sent towards the device.
required: false
schema:
type: string
type: string
enum: [twin, live]
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: channel
in: query
description: |-
Defines to which channel to route the command: `twin` (digital twin) or `live` (the device).
* If setting the channel parameter is omitted, the `twin` channel is set by default and the command is routed to the digital representation of a thing in Bosch IoT Things backend.
* When using the `live` channel, the command/message is sent towards the device.
The option `live` is not available when a new thing should be created, only for updating an
existing thing.
required: false
schema:
type: string
enum: [twin, live]
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ get:
- $ref: '../../parameters/ifNoneMatchHeaderParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
- $ref: '../../parameters/conditionParam.yml'
- $ref: '../../parameters/channelParam.yml'
- $ref: '../../parameters/channelParamPutDescription.yml'
responses:
'200':
description: The request successfully returned the specific thing.
Expand Down

0 comments on commit f38c5d4

Please sign in to comment.