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.

Sign up for GitHub

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

Jump to bottom

refactor(deps)!: remove swagger-ui-react #13818

Merged
merged 8 commits into from
Oct 30, 2024
Merged

refactor(deps)!: remove swagger-ui-react #13818

merged 8 commits into from
Oct 30, 2024

Commits on Oct 28, 2024

  1. refactor(ui)!: remove Swagger UI 

    - replace with a versioned link to the Swagger UI in the Docs
  - and downloads of the current API spec and JSON schema to use your exact version locally

- Note: the `download` doesn't seem to be working in my browser for some reason...

Signed-off-by: Anton Gilgur <[email protected]>
    @agilgur5
    agilgur5 committed Oct 28, 2024
    Configuration menu
    Copy the full SHA
    654271d View commit details
    Browse the repository at this point in the history

  2. replace other UI links to the API Docs with versioned docs links as well 

    - could leave them as-is, but they seem to be intended for use with the Swagger UI

Signed-off-by: Anton Gilgur <[email protected]>
    @agilgur5
    agilgur5 committed Oct 28, 2024
    Configuration menu
    Copy the full SHA
    2130b82 View commit details
    Browse the repository at this point in the history

  3. docs: update and simplify REST API page 

    - client auth and access tokens are already described in other pages, can remove these and just link
- remove bullet about interactive usage in the UI
- update bullet about the swagger reference as it is always up-to-date (it pulls from `main`) and can be versioned now as well

Signed-off-by: Anton Gilgur <[email protected]>
    @agilgur5
    agilgur5 committed Oct 28, 2024
    Configuration menu
    Copy the full SHA
    0b1f300 View commit details
    Browse the repository at this point in the history

  4. remove swagger-ui-react dep 

    - shaves off a ton from the bundle (2nd biggest dep, only after Monaco Editor)
- resolves CVEs that were specific to Swagger UI's deps by just removing them entirely

Signed-off-by: Anton Gilgur <[email protected]>
    @agilgur5
    agilgur5 committed Oct 28, 2024
    Configuration menu
    Copy the full SHA
    99843ae View commit details
    Browse the repository at this point in the history

  5. fix download syntax 

    Signed-off-by: Anton Gilgur <[email protected]>
    @agilgur5
    agilgur5 committed Oct 28, 2024
    Configuration menu
    Copy the full SHA
    40ce88a View commit details
    Browse the repository at this point in the history

  6. also remove @types/swagger-ui-react 

    Signed-off-by: Anton Gilgur <[email protected]>
    @agilgur5
    agilgur5 committed Oct 28, 2024
    Configuration menu
    Copy the full SHA
    ab49ca7 View commit details
    Browse the repository at this point in the history

  7. add upgrading note about removal + replacement 

    Signed-off-by: Anton Gilgur <[email protected]>
    @agilgur5
    agilgur5 committed Oct 28, 2024
    Configuration menu
    Copy the full SHA
    d706239 View commit details
    Browse the repository at this point in the history

Commits on Oct 30, 2024

  1. Merge branch 'main' into refactor-remove-swagger-ui 

    Signed-off-by: Mason Malone <[email protected]>
    @MasonM
    MasonM committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    d31d969 View commit details
    Browse the repository at this point in the history