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

Update OAS file to match v0.21 #1049

Merged
merged 5 commits into from Aug 12, 2021
Merged

Update OAS file to match v0.21 #1049

merged 5 commits into from Aug 12, 2021

Conversation

gmourier
Copy link
Member

@gmourier gmourier commented Jul 29, 2021

  • Remove OAS definition from the documentation repository
  • Remove UI building from the documentation repository
  • Updates links to point to bump.sh lastest version and OAS version to 3.1.0

@guimachiavelli Unfortunately swaggerUI is not able to handle the 3.1.0 OAS version format at the moment. I tried to update the swagger dists to the latest stable version to check if 3.1.0 could be generated with swaggerUI which provides a test interface. swagger-api/swagger-ui#5891

Bump.sh doesn't have a live test interface yet. By merging this PR we have an updated OAS interface with 0.21 but we lose the possibility to test the API from the web.

I'm looking for a simple workaround to keep this swaggerUI interface for live testing.

Edit: I found a workaround by forcing the version of the open-api file to be 3.0.3 instead of 3.1.0 but the version generated by swaggerUI no longer offers all the examples since the 3.1.0 format changed it and it forces us to maintain 2 versions just to be able to keep swaggerUI.

According to the stats I have this page is very little visited, if ever.

@gmourier gmourier changed the title Update OpenApi 0.21 Update OAS file to match v0.21 Jul 29, 2021
Copy link
Member

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🎂

I will merge this into the prepare v0.21 branch so we deploy it only once everything's ready.

@guimachiavelli guimachiavelli changed the base branch from master to prepare-docs-v0.21 August 11, 2021 15:59
@guimachiavelli guimachiavelli merged commit 2f21745 into meilisearch:prepare-docs-v0.21 Aug 12, 2021
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

2 participants