Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update docs to use true/false for ds-pushevent and ds-returnevent in 3.0 #917

Merged
merged 1 commit into from
Jan 30, 2023
Merged

docs: Update docs to use true/false for ds-pushevent and ds-returnevent in 3.0 #917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs_src/design/adr/0023-North-South-Messaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,8 @@ Command requests in HTTP may also contain ds-pushevent and ds-returnevent query
"Correlation-ID": "14a42ea6-c394-41c3-8bcd-a29b9f5e6835",
"API":"V2",
"queryParams": {
"ds-pushevent":"yes",
"ds-returnevent":"yes",
"ds-pushevent":"true",
"ds-returnevent":"true",
}
...
}
Expand All @@ -149,8 +149,8 @@ In the example GET and PUT messages below, note the `envelope` wraps or encases
"apiVersion": "v2",
"requestId": "e6e8a2f4-eb14-4649-9e2b-175247911369",
"queryParams": {
"ds-pushevent":"yes",
"ds-returnevent":"yes",
"ds-pushevent":"true",
"ds-returnevent":"true",
}
}

Expand Down
12 changes: 8 additions & 4 deletions docs_src/design/adr/device-service/0011-DeviceService-Rest-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,14 @@ The fields of an Event are as follows:

Calls to the device endpoints may include a Query String in the URL. This may be used to pass parameters relating to the request to the device service. Individual device services may define their own parameters to control specific behaviors. Parameters beginning with the prefix `ds-` are reserved to the Device SDKs and the following parameters are defined for GET requests:

| Parameter | Valid Values | Default | Meaning
| --- | --- | --- | ---
| *ds-pushevent* | "yes" or "no" | "no" | If set to yes, a successful `GET` will result in an event being pushed to the EdgeX system
| *ds-returnevent* | "yes" or "no" | "yes" | If set to no, there will be no Event returned in the http response
| Parameter | Valid Values | Default | Meaning
| --- |-------------------|---------| ---
| *ds-pushevent* | "true" or "false" | "false" | If set to true, a successful `GET` will result in an event being pushed to the EdgeX system
| *ds-returnevent* | "true" or "false" | "true" | If set to false, there will be no Event returned in the http response

!!! edgey "EdgeX 3.0"
The valid values of **ds-pushevent** and **ds-returnevent** is changed to `true/false` instead of `yes/no` in EdgeX 3.0.


#### Device States

Expand Down
4 changes: 2 additions & 2 deletions docs_src/microservices/core/command/Ch-Command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,8 +380,8 @@ Example of making get command request via messaging:
"CorrelationID": "14a42ea6-c394-41c3-8bcd-a29b9f5e6835",
"RequestId": "e6e8a2f4-eb14-4649-9e2b-175247911369",
"QueryParams": {
"ds-pushevent": "no",
"ds-returnevent": "yes"
"ds-pushevent": "false",
"ds-returnevent": "true"
}
}
```
Expand Down