opengeospatial / opengeospatial/ogcapi-processes
Inconsistent Part 3 `sortBy` definitions
Nobody has claimed this yet.
- Dominant language
- AsciiDoc
- Stars
- 63
- Forks
- 46
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 8
Description
However, the schema shows:
https://github.com/opengeospatial/ogcapi-processes/blob/b5105df0384254e02dd3d77f2ce24d32fc6f2506/openapi/schemas/processes-workflows/fieldsModifiers.yaml#L13-L16
What is expected?
{ "sortBy": "a,-b,+c" }
or
{ "sortBy": ["a", "-b", "+c"] }
or both?
The string part should reuse the ordering pattern:
https://github.com/opengeospatial/ogcapi-features/blob/0c508be34aaca0d9cf5e05722276a0ee10585d61/extensions/sorting/standard/openapi/parameters/sortby.yaml#L12-L17
Also, the second part of the requirement mentions CQL2 as sorting expression.
CQL2 should allow the JSON variant as well?
Should the schema use https://github.com/opengeospatial/ogcapi-features/blob/master/cql2/standard/schema/cql2.json instead?
Furthermore, given this different sorting language, should a sortBy-lang parameter be considered?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the sorting requirement in extensions/workflows/requirements/input-fields-modifiers/REQ_input-fields-modifiers_sorting.adoc with openapi/schemas/processes-workflows/fieldsModifiers.yaml. Review the referenced OGC API Features ordering pattern and CQL2 schema, then resolve which representations and language parameter are supported. Done means the requirement and schema consistently document the agreed behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100