OpenAPI spec for TAP-1.1 compatible API for WD-TAP-1.2 #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
move root openapi.yaml out of openapi components dir
pdowler
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This describes a TAP-1.1 compatible API modulo changes in the upstream dependencies:
The openapi dir holds the components that TAP specifies.
The openapi.yaml (example) refers to components laid out in a sub-directory like
openapi/{std}/{component}which is not the
openapihere. Thisopenapidir is the source from which one would createopenapi/tap/(and likewise for vosi, dali, uws).For an example of the result, I pull all the components from VOSI, DALI, and TAP into our youcat service (plus I have some stub UWS components in there) and have an almost identical openapi.yaml that (i) has no errors but lots of warnings using an off-the shelf openapi validator and (ii) when built correctly, can use swagger to render decent API docs (sorry, not deployed yet, still in my dev repo). All the yaml can be seen here:
https://github.com/pdowler/tap/tree/openapi/youcat/src/main/webapp
A not-too-complicated build could assemble the components and validate, which is nominally validate the TAP openapi spec. We could (in principle) assemble and deploy the spec with swagger UI (or somesuch) or services can do that and deploy it with their implementation (we do that).