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

Lock openapi schema version for swagger UI to 3.0.2 #887

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Conversation

dancoates
Copy link
Contributor

Not quite sure why this suddenly broke, but this seems to fix it

Copy link

codecov bot commented Aug 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.54%. Comparing base (dca9464) to head (82a5b20).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #887   +/-   ##
=======================================
  Coverage   80.54%   80.54%           
=======================================
  Files         172      172           
  Lines       14641    14641           
=======================================
  Hits        11793    11793           
  Misses       2848     2848           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@illusional illusional left a comment

Choose a reason for hiding this comment

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

I thought swagger UI would support 3.1.0 fine? Or if it's the react flavour, should update swagger on the front-end.

The actual openapi generator should not use this function anymore.

@dancoates
Copy link
Contributor Author

Yeah fair point, I was tossing up whether to upgrade the swagger UI, it's a major version upgrade so could break things but I'll give it a shot

@dancoates
Copy link
Contributor Author

@illusional I had a crack at updating to the new swagger ui react to support openapi def 3.1.0, but it is a bit of a rabbit hole, v5 of swagger UI requires v9 of react-redux which requires v18 of react, and upgrading to v18 of react requires updating most of our component libraries, I'm not even sure all of them will support react 18. I think it'd be good to get temporary fix out and look at upgrading react separately.

@dancoates dancoates mentioned this pull request Aug 6, 2024
@dancoates dancoates changed the title fix openapi generation for swagger ui to 3.0.2 for compatibility Lock openapi schema version for swagger UI to 3.0.2 Aug 6, 2024
Copy link
Collaborator

@illusional illusional left a comment

Choose a reason for hiding this comment

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

Ooft, what a rabbit hole.

@dancoates dancoates merged commit 83556a3 into dev Aug 6, 2024
7 checks passed
@dancoates dancoates deleted the fix-swagger-ui branch August 6, 2024 04:20
dancoates added a commit that referenced this pull request Aug 6, 2024
* [test] Silence port errors + simplify test db construction (#886)

* Attempt to silence port errors

* Try not casting to an int

* Maybe test not binding?

* Try another approach

* PR clean-up

* Linting

* Actually save the fiel

* Reinstate findfreeport but use it better

* Disable + re-disable loggers

---------

Co-authored-by: Michael Franklin <illusional@users.noreply.github.com>

* Upgrade deprecated pydantic methods (#888)

Co-authored-by: Michael Franklin <illusional@users.noreply.github.com>

* fix openapi generation for swagger ui to 3.0.2 for compatibility (#887)

---------

Co-authored-by: Michael Franklin <22381693+illusional@users.noreply.github.com>
Co-authored-by: Michael Franklin <illusional@users.noreply.github.com>
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.

2 participants