improve OpenAPI examples for per-content-type process deployment#998
Open
fmigneault wants to merge 1 commit into
Open
improve OpenAPI examples for per-content-type process deployment#998fmigneault wants to merge 1 commit into
fmigneault wants to merge 1 commit into
Conversation
github-actions
Bot
added
ci/doc
Nazim-crim
reviewed
Jul 21, 2026
Comment on lines
+7595
to
+7596
| ContentType.APP_YAML, | ||
| ContentType.APP_JSON, |
Contributor
There was a problem hiding this comment.
Shouldnt this be already covered with
ContentType.APP_CWL_JSON,
ContentType.APP_CWL_YAML,
Why do we need those two
Nazim-crim
reviewed
Jul 21, 2026
Comment on lines
+7647
to
+7655
| header = DeployHeadersOGC(description="Headers employed for process deployment.") | ||
| querystring = FormatQuery() | ||
| body = DeployBodyOGC() | ||
|
|
||
|
|
||
| class PostProcessesEndpointCWL(PostProcessesEndpoint): | ||
| header = DeployHeadersCWL(description="Headers employed for process deployment.") | ||
| querystring = FormatQuery() | ||
| body = DeployBodyCWL() |
Contributor
There was a problem hiding this comment.
The description could reflect if its CWL or OGC headers for more context
Nazim-crim
approved these changes
Jul 21, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes
API rendering used to return the examples in mixed order/combination per request body content-type because they were are combined under one schema.
Now, they properly offer all media-types (some of which were missing), and picking one will offer corresponding OGC/CWL representations.
For now, JSON/YAML are still returned together. Otherwise we would need to create even more schema class combinations to actually represent each one separately. We keep it relatively simple with that simplification.