Repository navigation
Improve wording of info.description in API definitions - #208
Open
jimfengjinhua wants to merge 1 commit into
Open
jimfengjinhua wants to merge 1 commit into
jimfengjinhua wants to merge 1 commit into
Conversation
Address documentation review comments: - Accesses: explain the per-device access status, fix status/state usage, clarify the 429 error result and the callback description - Areas: clarify that areas are available to the API consumer - Network Profiles: grammar fixes, replace "API family" with "API" - Networks: clarify the callback description Fixes camaraproject#202
jimfengjinhua
requested review from
PeterKovacs2,
carlosromerog,
eric-murray and
tlohmar
as code owners
October 21, 2026 12:59
tlohmar
approved these changes
Oct 22, 2026
tlohmar
left a comment
Contributor
There was a problem hiding this comment.
Looks good. We need to merge this soon to prevent collisions
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Addresses the review comments on the
info.descriptionsections in #202.Dedicated Network - Accesses API
statusis: the status of the device's access to the dedicated network in the context of the access (REQUESTED,GRANTEDorDENIED), with a link to the state description in the General Description.429 QUOTA_EXCEEDEDresult is no longer described as "the device status".Dedicated Network - Areas API
Dedicated Network - Network Profiles API
Dedicated Network - Networks API
Which issue(s) this PR fixes:
Fixes #202
Special notes for reviewers:
On "status" vs "state": we've kept both terms deliberately, using each as English normally does.
GRANTED", "status change".GRANTEDstate", "transitions toDENIEDstate".This matches the existing
DeviceStatusandNetworkStatusschema descriptions and theINVALID_STATEerror code, so the Networks API needed no further changes. Places where "status" or "state" was used wrongly have been fixed.Changelog input
Additional documentation
This section can be blank.