Skip to content

Describe single-device operations in General Description - #210

Open
jimfengjinhua wants to merge 1 commit into
camaraproject:mainfrom
jimfengjinhua:fix/issue204-general-description-single-device
Open

jimfengjinhua wants to merge 1 commit into
camaraproject:mainfrom
jimfengjinhua:fix/issue204-general-description-single-device

Conversation

@jimfengjinhua

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • documentation

What this PR does / why we need it:

The General Description had not been updated for the single-device operations and three-legged access token support added in r2.3. This PR:

  • Adds a section "Managing devices in an access" with:
    • a table of all multiple-device and single-device operations and the access tokens each one supports, matching the operations and scopes in dedicated-network-accesses.yaml
    • an introduction to accessDeviceId
    • how the device is identified with a two-legged and with a three-legged access token. For error handling it refers to the Accesses API specification.
  • Introduction: mentions three-legged access token support for the single-device operations, and fixes "using using" and "a two-legged access tokens".
  • "States of device's access to the network": the old list of operations, which covered only the multiple-device add, remove and list operations, is replaced by a link to the new section.
  • Fixes the high-level sequence diagram:
    • DELETE /accesses (accessId) → DELETE /accesses/{accessId}
    • the Areas and Accesses participants were both declared as A, so Mermaid merged them. Areas is now AR, and the area discovery step now goes to the Areas API instead of the Profiles API.
    • the access callback and polling now come from the Accesses API instead of the Networks API
    • steps are numbered 1–5 (step 3 appeared twice), matching "Description of main steps"

Which issue(s) this PR fixes:

Fixes #204

Special notes for reviewers:

Changelog input

 release-note
Updated the General Description with the single-device operations, three-legged access token support and accessDeviceId, and corrected the high-level sequence diagram

Additional documentation

docs

- Add a "Managing devices in an access" section listing the
  multiple-device and single-device operations with the supported
  access tokens, introducing accessDeviceId and explaining how the
  device is identified with two-legged and three-legged access tokens
- Mention three-legged access token support in the introduction
- Fix the sequence diagram: DELETE /accesses/{accessId} path, separate
  participants for the Areas and Accesses APIs, access callback and
  polling from the Accesses API, and step numbering

Fixes camaraproject#204
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] General Description does not cover the single-device operations

1 participant