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: add swagger ui in docs #15209

Closed
wants to merge 4 commits into from
Closed

docs: add swagger ui in docs #15209

wants to merge 4 commits into from

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Feb 27, 2023

Description

Closes: #15112
Waiting on PaloAltoNetworks/docusaurus-openapi-docs#396, the diff here will be smaller too ater that.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@tac0turtle tac0turtle added the S:blocked Status: Blocked label Feb 28, 2023
@julienrbrt
Copy link
Member Author

image
I think we should update the CSS to do not display a codeblock; otherwise it is a bit weird. Moreover there seems to be collisions in the urls (as the plugin takes the last part of the query).
I will tonight again investigate another way,

@julienrbrt
Copy link
Member Author

julienrbrt commented Mar 1, 2023

Closing this as using this plugin does not fit our needs.
We should simply copy /client/docs/swagger-ui at build time to the docs.

@julienrbrt julienrbrt closed this Mar 1, 2023
@julienrbrt julienrbrt deleted the julien/swagger branch March 1, 2023 17:48
@julienrbrt julienrbrt mentioned this pull request Mar 2, 2023
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S:blocked Status: Blocked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: swagger docs are outdated and dont work.
2 participants