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

Conformance classes in OpenAPI schema #361

Closed
emmanuelmathot opened this issue Nov 29, 2022 · 2 comments
Closed

Conformance classes in OpenAPI schema #361

emmanuelmathot opened this issue Nov 29, 2022 · 2 comments
Assignees
Milestone

Comments

@emmanuelmathot
Copy link
Collaborator

It would be useful to have the conformance classes directly specified in the schemas. We could use it to automatically generate the landing page in the case of a STAC API framework leveraging code generation.
It would be possible to specify them at schema or operation level for a fine granularity. For instance with item-search:

openapi: 3.0.3
info:
  title: STAC API - Item Search
  version: 1.0.0-rc.2
  description: >-
    This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Item Search
    specification.
  contact:
    name: STAC Specification
    url: 'http://stacspec.org'
  license:
    name: Apache License 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0'
  conformance: [ "https://api.stacspec.org/v1.0.0-rc.2/item-search" ]
tags:
  - name: Item Search
    description: essential characteristics of a STAC API
paths:
[...]
@philvarner philvarner added this to the 1.0.0-rc.3 milestone Jan 30, 2023
@philvarner philvarner self-assigned this Jan 30, 2023
@philvarner
Copy link
Collaborator

Additional fields have to start with x-. I'm adding a field with name x-conformance-classes.

@philvarner
Copy link
Collaborator

These were added to the Foundation specs. I've made a mental note to add it to the extensions (but not filed the ~8 issues against every extension that could use it)

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