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

Fix examples, and upgrade examples to OAS3 #501

Merged
merged 2 commits into from
Apr 28, 2022
Merged

Conversation

sergioisidoro
Copy link
Member

@sergioisidoro sergioisidoro commented Feb 22, 2022

Problem

  • Examples are not showing because they have been moved in the later specification inside the mime type, and now have a new format (see link bellow)

Solution

Started at #500 but took a bit more idealistic approach here into turning the metadata object already as close as possible to the OAS3 specification. As mentioned in #500, the metadata object is diverging quite a lot from the OAS specification, so this is already an attempt at bringing it back to as close to the final swagger document as possible.

Moves examples into the new OAS3 example specification

This concerns this parts of the Open API Specification:

The changes I made are compatible with:

  • OAS2
  • OAS3
  • OAS3.1

Related Issues

Links to any related issues.

Checklist

  • Added tests
  • Changelog updated
  • Added documentation to README.md

@BookOfGreg BookOfGreg added this to the Gem 3.0.0 milestone Feb 25, 2022
@sergioisidoro sergioisidoro merged commit b22a485 into master Apr 28, 2022
@sergioisidoro
Copy link
Member Author

Sorry for the long delay on this. I made some final checks, and since this was already approved, I went ahead and clicked the merge button :)

@dollerbill
Copy link

@sergioisidoro sorry to bug you but is this feature being held until version 3.0? Or should we expect another 2.x release with some of these recent changes?

@jtannas jtannas deleted the oas3-examples branch September 9, 2022 15:22
romanblanco added a commit to romanblanco/compliance-backend that referenced this pull request Sep 23, 2022
rswag/rswag#501

bundle update rswag-specs
bundle update rswag-api
bundle update rswag-ui
romanblanco added a commit to romanblanco/compliance-backend that referenced this pull request Sep 26, 2022
              Fix for response examples [1] has been recently released
              in version rswag 2.6.0 [2]

              The commit is updating rswag packages to the latest
              version:

              $ bundle update rswag-specs
              $ bundle update rswag-api
              $ bundle update rswag-ui

              [1] rswag/rswag#501
              [2] https://github.com/rswag/rswag/releases/tag/2.6.0
romanblanco added a commit to romanblanco/compliance-backend that referenced this pull request Sep 26, 2022
              Fix for response examples [1] has been recently released
              in version rswag 2.6.0 [2]

              The commit is updating rswag packages to the latest
              version:

              $ bundle update rswag-specs
              $ bundle update rswag-api
              $ bundle update rswag-ui

              [1] rswag/rswag#501
              [2] https://github.com/rswag/rswag/releases/tag/2.6.0
romanblanco added a commit to RedHatInsights/compliance-backend that referenced this pull request Sep 26, 2022
              Fix for response examples [1] has been recently released
              in version rswag 2.6.0 [2]

              The commit is updating rswag packages to the latest
              version:

              $ bundle update rswag-specs
              $ bundle update rswag-api
              $ bundle update rswag-ui

              [1] rswag/rswag#501
              [2] https://github.com/rswag/rswag/releases/tag/2.6.0
@romanblanco romanblanco mentioned this pull request Mar 20, 2023
@romanblanco
Copy link
Member

@dollerbill, this was released already, removing Gem 3.0.0 milestone.

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

Successfully merging this pull request may close these issues.

None yet

4 participants