Skip to content

Commit

Permalink
fix that "version" in ditto header defines that it can take 1 or 2 ..
Browse files Browse the repository at this point in the history 
Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
  • Loading branch information
@thjaeckle
thjaeckle committed Mar 30, 2022
1 parent 06fa787 commit 0504f42
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions documentation/src/main/resources/pages/ditto/protocol-specification.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,21 +86,21 @@ since they are themselves not case-sensitive.

There are some pre-defined headers, which have a special meaning for Ditto:

| Header Key | Description | Possible values |
|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| `content-type` | The content-type which describes the [value](#value) of Ditto Protocol messages. | `String` |
| `correlation-id` | Used for correlating protocol messages (e.g. a **command** would have the same correlation-id as the sent back **response** message). | `String` |
| `ditto-originator` | Contains the first authorization subject of the command that caused the sending of this message. Set by Ditto. | `String` |
| `if-match` | Has the same semantics as defined for the [HTTP API](httpapi-concepts.html#conditional-requests). | `String` |
| `if-none-match` | Has the same semantics as defined for the [HTTP API](httpapi-concepts.html#conditional-requests). | `String` |
| `response-required` | Configures for a **command** whether or not a **response** should be sent back. | `Boolean` - default: `true` |
| `requested-acks` | Defines which [acknowledgements](basic-acknowledgements.html) are requested for a command processed by Ditto. | `JsonArray` of `String` - default: `["twin-persisted"]` |
| `ditto-weak-ack` | Marks [weak acknowledgements](basic-acknowledgements.html) issued by Ditto. | `Boolean` - default: `false` |
| `timeout` | Defines how long the Ditto server should wait, e.g. applied when waiting for requested acknowledgements. | `String` - e.g.: `42s` or `250ms` or `1m` - default: `60s` |
| `version` | Determines in which schema version the `payload` should be interpreted. | `Number` - currently: \[1,2\] |
| `put-metadata` | Determines which Metadata information is stored in the thing. | `JsonArray` of `JsonObject`s containing [metadata](basic-metadata.html) to apply. |
| `condition` | The condition to evaluate before applying the request. | `String` containing [condition](basic-conditional-requests.html) to apply. |
| `live-channel-condition` | The condition to evaluate before retrieving thing data from the device. | `String` containing [live channel condition](basic-conditional-requests.html#live-channel-condition) to apply. |
| Header Key | Description | Possible values |
|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `content-type` | The content-type which describes the [value](#value) of Ditto Protocol messages. | `String` |
| `correlation-id` | Used for correlating protocol messages (e.g. a **command** would have the same correlation-id as the sent back **response** message). | `String` |
| `ditto-originator` | Contains the first authorization subject of the command that caused the sending of this message. Set by Ditto. | `String` |
| `if-match` | Has the same semantics as defined for the [HTTP API](httpapi-concepts.html#conditional-requests). | `String` |
| `if-none-match` | Has the same semantics as defined for the [HTTP API](httpapi-concepts.html#conditional-requests). | `String` |
| `response-required` | Configures for a **command** whether or not a **response** should be sent back. | `Boolean` - default: `true` |
| `requested-acks` | Defines which [acknowledgements](basic-acknowledgements.html) are requested for a command processed by Ditto. | `JsonArray` of `String` - default: `["twin-persisted"]` |
| `ditto-weak-ack` | Marks [weak acknowledgements](basic-acknowledgements.html) issued by Ditto. | `Boolean` - default: `false` |
| `timeout` | Defines how long the Ditto server should wait, e.g. applied when waiting for requested acknowledgements. | `String` - e.g.: `42s` or `250ms` or `1m` - default: `60s` |
| `version` | Determines in which schema version the `payload` should be interpreted. | `Number` - currently possible: \[2\] - default: `2` |
| `put-metadata` | Determines which Metadata information is stored in the thing. | `JsonArray` of `JsonObject`s containing [metadata](basic-metadata.html) to apply. |
| `condition` | The condition to evaluate before applying the request. | `String` containing [condition](basic-conditional-requests.html) to apply. |
| `live-channel-condition` | The condition to evaluate before retrieving thing data from the device. | `String` containing [live channel condition](basic-conditional-requests.html#live-channel-condition) to apply. |
| `live-channel-timeout-strategy` | The strategy to apply when a [live](protocol-twinlive.html#live) command was not answered by the actual device within the defined `timeout`. | `fail`: let the request fail with a 408 timeout error - `use-twin`: fall back to the twin, retrieving the persisted data. |

Custom headers of messages through the [live channel](protocol-twinlive.html#live) are delivered verbatim. When naming
Expand Down

0 comments on commit 0504f42

Please sign in to comment.