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

docs: update SwaggerUI version #12518

Merged
merged 2 commits into from
Feb 9, 2024
Merged

Commits on Jan 14, 2024

  1. docs: update SwaggerUI version

    - use latest [5.11.0](https://github.com/swagger-api/swagger-ui/releases/tag/v5.11.0) instead of the 2 years outdated [4.5.0](https://github.com/swagger-api/swagger-ui/releases/tag/v4.5.0)
      - it seems like the version was taken directly from [the SwaggerUI installation docs](https://github.com/swagger-api/swagger-ui/blob/v5.11.0/docs/usage/installation.md#unpkg), which still has an old version listed
        - in fact, the entire code block was taken from the doc
          - significantly simplify the code block as it renders inside of existing MD/HTML
            - a second `DOCTYPE`, `html`, `head`, `body`, etc tags are actually invalid HTML, but either `mkdocs` ignored some of those or browsers just ignore some of those
              - fixing invalid HTML makes this doc page more robust
          - also fix the indentation in the code block too, which also did not meet style guidelines
    
    - this seems to make it slightly more performant, which is our main issue, but also has other benefits of using a current version of a dep
    
    - add a `markdownlint-disable` comment to allow the inline HTML
      - add a comment describing why it's necessary
        - similarly add a comment to the PR template explaining why that one is necessary too
      - remove the `Makefile`'s ignore on `swagger.md` for docs linting et al
    
    Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
    agilgur5 committed Jan 14, 2024
    Configuration menu
    Copy the full SHA
    379943b View commit details
    Browse the repository at this point in the history

Commits on Feb 9, 2024

  1. Merge branch 'main' into docs-update-swagger-ui

    Signed-off-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
    agilgur5 authored Feb 9, 2024
    Configuration menu
    Copy the full SHA
    43a751a View commit details
    Browse the repository at this point in the history