fix: openapi spec version element #6780
Merged
Conversation
This file contains 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
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
We are adding blank versions as version info is captured in links shown on api SPEC when rendered on Swagger-UI Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
We are adding blank versions as version info is captured in links shown on api SPEC when rendered on Swagger-UI Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Adding `OAS Version` as version since `version` element is mandatory but we don't want to maintain version info in this tag. Version info is already available in URL path. Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
ossdhaval
requested review from
pujavs,
yuriyz,
yurem and
jgomer2001
as code owners
mo-auto
added
comp-jans-auth-server
pujavs
approved these changes
Nov 28, 2023
|
[jans-linux-setup] Kudos, SonarCloud Quality Gate passed!聽 聽
|
|
[agama parent] Kudos, SonarCloud Quality Gate passed!聽 聽
|
yuriyz
approved these changes
Nov 28, 2023
|
[jans-config-api-parent] Kudos, SonarCloud Quality Gate passed!聽 聽
|
|
[SCIM API] Kudos, SonarCloud Quality Gate passed!聽 聽
|
|
[Fido2 API] Kudos, SonarCloud Quality Gate passed!聽 聽
|
jgomer2001
approved these changes
Nov 29, 2023
yurem
approved these changes
Nov 29, 2023
This was referenced Dec 11, 2023
devrimyatar
pushed a commit
that referenced
this pull request
Dec 30, 2023
* docs: add `version` tag to auth-server spec Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: add `version` tag to fido2 spec We are adding blank versions as version info is captured in links shown on api SPEC when rendered on Swagger-UI Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: add `version` tag to SCIM spec We are adding blank versions as version info is captured in links shown on api SPEC when rendered on Swagger-UI Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: add `version` tag API SPECs Adding `OAS Version` as version since `version` element is mandatory but we don't want to maintain version info in this tag. Version info is already available in URL path. Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> --------- Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> Signed-off-by: Mustafa Baser <mbaser@mail.com>
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.
Prepare
Description
Since we do not want to use the
info->versionelement but we have to because theeditor.swagger.ioshows warning otherwise.Ideal solution is to put
vreplace-janssen-versionin there and let the release process fill in the right version number. But at the moment yaml files are not covered in this replacement process. So as a stop-gap, I have added version with static value ofOAS Versionas it looks logical on screen 馃憞 and doesn't have to be replaced.closes #6622
Test and Document the changes