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

refactor: removes deprecated OpenAPIController #3360

Merged
merged 7 commits into from
Apr 10, 2024

Conversation

peterschutt
Copy link
Contributor

Description

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

Supersedes #3297 which superseded #3271

Closes

@peterschutt peterschutt force-pushed the remove-openapi-controller-new-docs branch 2 times, most recently from 847a507 to 530d068 Compare April 9, 2024 23:25
Base automatically changed from new-docs to v3.0 April 10, 2024 06:59
This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.
@peterschutt peterschutt force-pushed the remove-openapi-controller-new-docs branch from 530d068 to acccd61 Compare April 10, 2024 07:21
@github-actions github-actions bot added area/docs This PR involves changes to the documentation area/openapi This PR involves changes to the OpenAPI schema area/private-api This PR involves changes to the privatized API size: medium pr/internal labels Apr 10, 2024
Copy link

codecov bot commented Apr 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.23%. Comparing base (9e08c8f) to head (be4cd12).

Additional details and impacted files
@@            Coverage Diff             @@
##             v3.0    #3360      +/-   ##
==========================================
- Coverage   98.24%   98.23%   -0.01%     
==========================================
  Files         321      320       -1     
  Lines       14686    14516     -170     
  Branches     2334     2305      -29     
==========================================
- Hits        14428    14260     -168     
+ Misses        116      115       -1     
+ Partials      142      141       -1     

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

docs/conf.py Show resolved Hide resolved
docs/release-notes/whats-new-3.rst Show resolved Hide resolved
Copy link
Member

@JacobCoffee JacobCoffee left a comment

Choose a reason for hiding this comment

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

I hope we can maintain the usage of versionadded and versionchanged across the next major, it is really helpful

docs/usage/openapi/ui_plugins.rst Outdated Show resolved Hide resolved
litestar/openapi/config.py Outdated Show resolved Hide resolved
litestar/openapi/config.py Show resolved Hide resolved
Co-authored-by: Jacob Coffee <jacob@z7x.org>
litestar/openapi/config.py Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
litestar/openapi/config.py Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Apr 10, 2024

Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3360

@peterschutt peterschutt merged commit 9d8134b into v3.0 Apr 10, 2024
28 checks passed
@peterschutt peterschutt deleted the remove-openapi-controller-new-docs branch April 10, 2024 21:34
provinzkraut pushed a commit that referenced this pull request Apr 13, 2024
* refactor: removes deprecated OpenAPIController

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

* docs: What's new entry

* Update docs/usage/openapi/ui_plugins.rst

Co-authored-by: Jacob Coffee <jacob@z7x.org>

* Update litestar/openapi/config.py

* fix: remove whitespace

* fix: import table formatting

(i hope)

---------

Co-authored-by: Jacob Coffee <jacob@z7x.org>
provinzkraut pushed a commit that referenced this pull request Apr 20, 2024
* refactor: removes deprecated OpenAPIController

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

* docs: What's new entry

* Update docs/usage/openapi/ui_plugins.rst

Co-authored-by: Jacob Coffee <jacob@z7x.org>

* Update litestar/openapi/config.py

* fix: remove whitespace

* fix: import table formatting

(i hope)

---------

Co-authored-by: Jacob Coffee <jacob@z7x.org>
provinzkraut pushed a commit that referenced this pull request Apr 21, 2024
* refactor: removes deprecated OpenAPIController

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

* docs: What's new entry

* Update docs/usage/openapi/ui_plugins.rst

Co-authored-by: Jacob Coffee <jacob@z7x.org>

* Update litestar/openapi/config.py

* fix: remove whitespace

* fix: import table formatting

(i hope)

---------

Co-authored-by: Jacob Coffee <jacob@z7x.org>
provinzkraut pushed a commit that referenced this pull request Apr 27, 2024
* refactor: removes deprecated OpenAPIController

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

* docs: What's new entry

* Update docs/usage/openapi/ui_plugins.rst

Co-authored-by: Jacob Coffee <jacob@z7x.org>

* Update litestar/openapi/config.py

* fix: remove whitespace

* fix: import table formatting

(i hope)

---------

Co-authored-by: Jacob Coffee <jacob@z7x.org>
provinzkraut pushed a commit that referenced this pull request Apr 27, 2024
* refactor: removes deprecated OpenAPIController

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

* docs: What's new entry

* Update docs/usage/openapi/ui_plugins.rst

Co-authored-by: Jacob Coffee <jacob@z7x.org>

* Update litestar/openapi/config.py

* fix: remove whitespace

* fix: import table formatting

(i hope)

---------

Co-authored-by: Jacob Coffee <jacob@z7x.org>
provinzkraut pushed a commit that referenced this pull request Apr 28, 2024
* refactor: removes deprecated OpenAPIController

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

* docs: What's new entry

* Update docs/usage/openapi/ui_plugins.rst

Co-authored-by: Jacob Coffee <jacob@z7x.org>

* Update litestar/openapi/config.py

* fix: remove whitespace

* fix: import table formatting

(i hope)

---------

Co-authored-by: Jacob Coffee <jacob@z7x.org>
provinzkraut pushed a commit that referenced this pull request May 25, 2024
* refactor: removes deprecated OpenAPIController

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

* docs: What's new entry

* Update docs/usage/openapi/ui_plugins.rst

Co-authored-by: Jacob Coffee <jacob@z7x.org>

* Update litestar/openapi/config.py

* fix: remove whitespace

* fix: import table formatting

(i hope)

---------

Co-authored-by: Jacob Coffee <jacob@z7x.org>
provinzkraut pushed a commit that referenced this pull request May 26, 2024
* refactor: removes deprecated OpenAPIController

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

* docs: What's new entry

* Update docs/usage/openapi/ui_plugins.rst

Co-authored-by: Jacob Coffee <jacob@z7x.org>

* Update litestar/openapi/config.py

* fix: remove whitespace

* fix: import table formatting

(i hope)

---------

Co-authored-by: Jacob Coffee <jacob@z7x.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This PR involves changes to the documentation area/openapi This PR involves changes to the OpenAPI schema area/private-api This PR involves changes to the privatized API pr/internal size: medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants