-
Notifications
You must be signed in to change notification settings - Fork 8
feat: Document startTime and endTime path params for /v1/frontHistory/:systemId
#7
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
base: main
Are you sure you want to change the base?
Conversation
|
Hey, thanks for the PR! But you need to change the SimplyPluralApi.yml and SimplyPluralApiBodies.yml files instead, then run the generator: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs?tab=readme-ov-file#generating-openapi-docs Modifying the .mdx files will just get overwritten once the yml files change and we run the generator again. |
Cellaryllis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to change the SimplyPluralApi.yml and SimplyPluralApiBodies.yml files instead, then run the generator: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs?tab=readme-ov-file#generating-openapi-docs
|
Hey @Cellaryllis - I spent a while trying to get docusaurus to run locally and I can't seem to do it without issues on the build phase (mostly |
|
Hey @ijsbol, We tried to do it locally now too, and we're on a new pc since our last generation and it also reported errors. Looks like there's some setup missing for the old version. In any case, we updated docusaurus as it was heavily outdated and updated yarn to 4.7.0, and now we can run yarn build and it builds the API + docs site. If you get latest, resolve the conflict (just accept remote changes), then yarn install and yarn build it should work now. If it doesn't, let me know and I'll locally get your PR, confirm it works, and merge regardless. |
| required: true | ||
| description: String Id of the system | ||
| - in: query | ||
| name: Start and End Times |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These should be two separate params
Documented previously undocumented required path parameters.