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

fix: Updated Device Service Walk-thru docs #1380

Closed
wants to merge 1 commit into from
Closed

fix: Updated Device Service Walk-thru docs #1380

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
12 changes: 4 additions & 8 deletions docs_src/walk-through/Ch-WalkthroughDeviceService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ data from the devices. See [Admin State documentation](../microservices/device/d

### Walkthrough - Device Service

> **Note**: The `camera-control-device-service` mentioned below is used for demonstration purposes. In a real-world scenario, make sure that this device service is running or replace it with an appropriate device service from your environment.

Use either the Postman or Curl tab below to walkthrough creating the `DeviceService`.

=== "Postman"
Expand All @@ -51,7 +53,7 @@ Use either the Postman or Curl tab below to walkthrough creating the `DeviceServ
}
```

Be sure that you are POSTing **raw** data, not form-encoded data. If your API call is successful, you will get a generated ID for your new `DeviceService` in the response area.
> **Important**: If the `camera-control-device-service` is not available, you can replace it with a service running in your environment (e.g., `example-device-service`).

=== "Curl"

Expand All @@ -63,10 +65,4 @@ Use either the Postman or Curl tab below to walkthrough creating the `DeviceServ

```

If your API call is successful, you will get a generated ID for your new `DeviceService`.

#### Test the GET API
If you make a GET call to the `http://localhost:59881/api/{{api_version}}/deviceservice/all` URL (with Postman or curl) you will get a listing (in JSON) of all the device services currently defined
in your instance of EdgeX, including the one you just added.

[<Back](Ch-WalkthroughDeviceProfile.md){: .md-button } [Next>](Ch-WalkthroughProvision.md){: .md-button }
> **Tip**: Replace `camera-control-device-service` with the appropriate service that is available in your environment.