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.

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

Create connected-network-type.yaml #158

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

gmuratk
Copy link
Contributor

@gmuratk gmuratk commented Jun 7, 2024

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature

What this PR does / why we need it:

#143 requests this enhancement/feature as new API under Device Status.

Which issue(s) this PR fixes:

Fixes #143

Special notes for reviewers:

Proposal doesn't include the subscriptions portion.

Changelog input

 release-note

Additional documentation

This section can be blank.

docs

@maxl2287
Copy link
Contributor

@camaraproject/device-status_codeowners I guess this can be moved together with #171 to the newly created https://github.com/camaraproject/DeviceQualityIndicator, do you agree?

@akoshunyadi
Copy link
Collaborator

@camaraproject/device-status_codeowners I guess this can be moved together with #171 to the newly created https://github.com/camaraproject/DeviceQualityIndicator, do you agree?

I think the quality indicator is something different. It will need different inputs, e.g. the network type, to provide a network quality indication.

Kevsy added a commit to Kevsy/APIBacklog that referenced this pull request Sep 27, 2024
Amended per API Backlog/Device Status discussion (ref Device Status [PR 158](camaraproject/DeviceStatus#158)
@akoshunyadi akoshunyadi marked this pull request as ready for review October 30, 2024 15:49
@gmuratk
Copy link
Contributor Author

gmuratk commented Nov 5, 2024

Thank you for all the comments over the past months. Since 'Draft' label is removed, we'll provide responses/edits soon.
cc: @murthygorty @RamTMO

Updates:
- Use of UNKNOWN for undetermined connection [technology]
- Simplified list of connection technologies
- Updates to Examples and API documentation in line with above points
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One typo in the tag

code/API_definitions/connected-network-type.yaml Outdated Show resolved Hide resolved
Update v0 - vwip
Corrected tag with matching strings
changed api-name to connected-network-type
changed path to /retrieve only
added to description of /retrieve method
changed schema label from RequestConnectedNetworkType to ConnectedNetworkTypeRequest
@eric-murray
Copy link
Collaborator

@gmuratk
If you had time, you could add the modified error response schema in CAMARA_common.yaml into the PR. But as this will be a WIP, we can add that later.

Comment on lines +262 to +263
required:
- device
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry - last minute review. device can't be required as a 3-legged token may be used. In that case, the request body would be an empty JSON object

Suggested change
required:
- device

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend: Device Status Connectivity with Standard
8 participants