Skip to content

Commit

Permalink
Adapt documentation due to name field in THING_CREATED and UPDATE_ATT…
Browse files Browse the repository at this point in the history
…RIBUTES

Signed-off-by: Ammar Bikic <[email protected]>
  • Loading branch information
AmmarBikic committed Sep 19, 2019
1 parent 66d52fb commit 22cf51c
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/content/apis/dmf_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,22 @@ Message Properties | Description
content_type | The content type of the payload | String | true
reply_to | Exchange to reply to. The default is sp.direct.exchange which is bound to the sp_direct_queue | String | false

Example headers
Example headers and payload:

Header | MessageProperties
----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------
type=THING\_CREATED <br /> tenant=tenant123 <br /> thingId=abc <br /> sender=Lwm2m | content\_type=application/json <br /> reply_to (optional) =sp.connector.replyTo

Payload Template (optional):

```json
{
"name": "String"
}
```

The "name" property specifies the name of the thing, which per default is the thing ID. This property is optional.

### UPDATE_ATTRIBUTES

Message to update target attributes. This message can be send in response to a _REQUEST_ATTRIBUTES_UPDATE_ event, sent by hawkBit.
Expand Down Expand Up @@ -88,10 +98,12 @@ Payload Template:
"exampleKey1" : "exampleValue1",
"exampleKey2" : "exampleValue2"
},
"name": "String",
"mode": "String"
}
```

The "name" property specifies the name of the thing. This property is optional. <br />
The "mode" property specifies the update mode that should be applied. This property is optional. Possible [mode](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfUpdateMode.java) values:

Value | Description
Expand Down

0 comments on commit 22cf51c

Please sign in to comment.