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

Inconsistent parameter names across the specification #479

Open
fmigneault opened this issue Dec 11, 2024 · 2 comments
Open

Inconsistent parameter names across the specification #479

fmigneault opened this issue Dec 11, 2024 · 2 comments

Comments

@fmigneault
Copy link
Contributor

There are multiple variations of parameter naming conventions employed across different documents:

  • jobID, jobId, job-id
  • processID, processId, process-id
  • outputID, output-name, "output name"
  • inputID, input-name, "input name"

The specific convention employed does not matter that much, but it should be somewhat consistent across the specification, just to facilitate referencing to them.

@jerstlouis
Copy link
Member

jerstlouis commented Dec 11, 2024

@fmigneault Note that there are different OGC API conventions for JSON schemas (camelCase) vs. query parameters (kebab-case).

See opengeospatial/ogcapi-common#224 (comment)

Not sure which kind of "parameters" you are referring to here.

Are these all path parameters as in OpenAPI? I would suggest {processId} as the convention for these.
So:

  • processId: JSON object property
  • {processId}: path parameter
  • process-id: query parameter

@fmigneault
Copy link
Contributor Author

I was referring to the path parameters.
All mentioned variants are observed across the various OpenAPI/Markdown/AsciiDoc documents.

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