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

Jump to bottom

CAMARA Common YAML: Both Address and Addr are used in object names #119

Open
Kevsy opened this issue Jan 10, 2024 · 1 comment · May be fixed by #120
Open

CAMARA Common YAML: Both Address and Addr are used in object names #119

Kevsy opened this issue Jan 10, 2024 · 1 comment · May be fixed by #120
Labels
backlog correction correction in documentation

Comments

@Kevsy
Copy link
Collaborator

Kevsy commented Jan 10, 2024

Problem description
Common.yaml uses 'Addr' in the object name for an IPv4 address, but (correctly) uses 'Address' in other object names:

Use of Addr:
#/components/schemas/SingleIpv4Addr
#/components/schemas/DeviceIpv4Addr

Use of Address:
ipv4Address
ipv6Address
#/components/schemas/DeviceIpv6Address
publicAddress:
privateAddress

The full form ("address" or "Address") is used throughout the documentation, while Addr is not.

Expected behavior
Change Addr to Address

Alternative solution

Additional context
@Kevsy Kevsy added the correction correction in documentation label Jan 10, 2024
Kevsy added a commit to Kevsy/Commonalities that referenced this issue Jan 10, 2024
@Kevsy
Update CAMARA_common.yaml: add Device headers, fix address
e4c8857 
Fixes camaraproject#118  camaraproject#119
@Kevsy Kevsy linked a pull request Jan 10, 2024 that will close this issue
Open
@Kevsy
Copy link
Collaborator Author

Kevsy commented Jan 10, 2024

Fixed in #120

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backlog correction correction in documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update CAMARA_common.yaml: add Device headers, fix address Kevsy/Commonalities
2 participants
@Kevsy @shilpa-padgaonkar