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

Simple Edge discovery API method parameters do not use lower camel case as in the rest of CAMARA APIs #158

Closed
sergiofranciscoortiz opened this issue Nov 29, 2023 · 5 comments

Comments

@sergiofranciscoortiz
Copy link
Collaborator

Similarly to the issue #151, we have noticed that apart from resource names, method attributes/parameters in Simple Edge Discovery API do not follow lower camel case naming.

Although it is apparently not strictly indicated in API Design Guidelines, it is defined to use camel case convention in several items and somehow hints to use it generally.

Furthermore it seems to be the widely use in other published CAMARA APIs as for example in BlockchainPublicAddress API, where the use phoneNumber as parameter for the method.

The suggestion is to adapt all paramaters to lower camel case notation, that would include:

Current Parameter Name Suggested lower camel case name
IP-Address ipAddress
Network-Access-Identifier networkAccessIdentifier
Phone-Number phoneNumber
@Kevsy
Copy link
Collaborator

Kevsy commented Dec 7, 2023

HI @sergiofranciscoortiz -

This is raised in Commonalities issue 105 in order to achieve consistency across all APIs.

I will add to that to issue to suggest that the guidelines need to explicitly define syntax for POST parameters (the link above only refers to path parameters, and querystring parameters are mentioned above it, but nothing explicit on POST (non-URL) parameters)

@sergiofranciscoortiz
Copy link
Collaborator Author

OK thanks, we can wait for the outcome of the discussion in commonalities.

@Kevsy
Copy link
Collaborator

Kevsy commented Jan 9, 2024

Updated the Commonalities issue as the Simple Edge Discovery API provides Device Identifiers as Headers (for which Uppercase-hyphen is the de facto standard).

@Kevsy
Copy link
Collaborator

Kevsy commented Jan 10, 2024

Now raised as PR 120 in Commonalities

If approved, then I will update the Simple Edge Discovery API to import those definitions.

@Kevsy
Copy link
Collaborator

Kevsy commented Apr 30, 2024

Outcome: agreed in Commonalities that Upper-kebab-case is appropriate for HTTP headers

@Kevsy Kevsy closed this as completed Apr 30, 2024
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

No branches or pull requests

2 participants