opengeospatial / opengeospatial/ogcapi-processes

1.0 - (JSON) Schemas for input and output definitions for

Open
#526 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

can we close
Dominant language
AsciiDoc
Stars
63
Forks
46
Avg merge
2d 1h
Merged PRs (30d)
8

Description

We are looking into how to define schemas as Building Blocks that can be used as part of input / output definitions in OGC API - Processes implementations. The problem is that we’re finding conflicting information on what those schemas should look like:

2.0 seems to support Draft 2020-12 completely (the schema $ref even points directly to the 2020-12 meta schema), so this a 1.0 issue only.

Could the spec be amended so that it says something like "an extended subset of JSON Schema" (which is the language OpenAPI 3.0 uses), or schema.yaml extended to include support for Draft 2020-12?

CC: @rob-metalinkage

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

Review the 1.0 requirements around schema in the linked OGC API - Processes specification, then compare inputDescription.yaml and schema.yaml in schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/. Check the 2.0 schema reference for contrast. Done means resolving whether 1.0 defines JSON Schema or an extended subset and identifying the required specification or schema amendment.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, openapi, yaml
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.