search

opengeospatial / NamingAuthority

Primary repo for the OGC Naming Authority
6 stars 12 forks source link

Adopt a policy that parameters should be in kebab-case #71

Closed ghobona closed 3 years ago

ghobona commented 3 years ago

There are different types of case styles.

The OGC API - Common SWG agreed to use kebab-case.

OGC API - Coverages SWG has agreed to use kebab-case.

The precedent is OGC API - Features - Part 2, which has been approved by the TC (i.e. bbox-crs).

EDR API currently uses lowerCamelCase. A ticket has been created for EDR API to be changed to kebab-case.

The OGC-NA has been asked to introduce policy requiring parameter names to be in kebab-case.

ghobona commented 3 years ago

Related discussion https://github.com/opengeospatial/ogcapi-environmental-data-retrieval/issues/170

ghobona commented 3 years ago

OGC API - Common SWG agreed on 2021-01-18 to include a Recommendation in OGC API - Common - Part 1: Core about using kebab-case.

joanma747 commented 3 years ago

There is an agreement in OGC API Common to accept kababcase for query parameters. For path parameters, they are replaced by values that ARE NOT affected by this recommendation (or policy).

joanma747 commented 3 years ago

Other "words" in the path such as "collections" or "tiles" etc. could also affected but it is unclear if the community agrees. In coverages "rangeSet" could be repladed by /range-set ?

hylkevds commented 3 years ago

That's annoying, it means implementers in quite a few languages (Java and JavaScript among them) can't use the same name for their variables as the name of the parameter.

ghobona commented 3 years ago

Closing this issue because a resolution was reached in OGC API - Common.