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

CAMARA Common YAML: addition of common HTTP Headers for Device Identifiers #118

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

CAMARA Common YAML: addition of common HTTP Headers for Device Identifiers #118

Kevsy opened this issue Jan 10, 2024 · 1 comment · May be fixed by #120
Labels
enhancement New feature or request

Comments

@Kevsy
Copy link
Collaborator

Kevsy commented Jan 10, 2024

Problem description
CAMARA_common.yaml does not account for Device Identifiers being provided as HTTP headers. Use of HTTP Headers is a recommendation in the API guidelines -
POST or GET for transferring sensitive or complex data
:

"When using GET, transfer the data using headers, which are not routinely logged or cached"

Possible evolution
Add reusable parameter definitions for these HTTP headers in CAMARA_common.yaml

Headers are typically Uppercase/hyphen-separated, and are documented that way in the HTTP Headers Definition section of the guidelines. Hence Device Identifier HTTP Headers would follow this convention:

IPv4-Address
IPv6-Address
Network-Access-Identifier
Phone-Number

Alternative solution
Define Device HTTP headers in each relevant CAMARA spec, which risks misalignment.

Additional context

@Kevsy Kevsy added the enhancement New feature or request label Jan 10, 2024
@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
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant