opengeospatial / opengeospatial/ogcapi-features

WFS3 Search extension.

Open
#79 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Part 10: Query (was: Search)
Dominant language
CSS
Stars
386
Forks
92
Avg merge
3d 4h
Merged PRs (30d)
15

Description

Update spec with a /search/ endpoint which accepts a POST request with a query in the body.

Issues:

  • Result
    • Return feature collection directly or new virtual collection which is then accessed at another endpoint (such as /searchresults/) where paging will be available.
  • Query Format
    • Do we need arbitrary query format?
    • Should we use an existing query tool/language such as openquery or cql? (benefit, familiarity/tooling)...
    • ...or should we simply define a json query object?
  • Queryable Parameters
    • The core will require the query parameters "BBOX" & "time"
    • The openapi doc for the service should define the queryable parameters beyond those defined in core.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing WFS3 specification and its OpenAPI document, then trace how endpoints, query parameters, and paging are currently defined. Resolve the open design questions for POST /search/, including result handling, query format, and the required BBOX and time parameters; done means the extension is specified consistently and its service-level queryables are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, backend-api-design, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.