Skip to content

Conversation

@ijsbol
Copy link
Contributor

@ijsbol ijsbol commented Feb 18, 2025

Documented previously undocumented required path parameters.

@Cellaryllis
Copy link
Contributor

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.

Copy link
Contributor

@Cellaryllis Cellaryllis left a 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

@ijsbol
Copy link
Contributor Author

ijsbol commented Mar 6, 2025

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 Module not found: Error: Can't resolve '@theme/ApiDemoPanel/MethodEndpoint') - I've updated the relevant yml file in my latest commit, just haven't been able to rebuild the docs.

@Cellaryllis
Copy link
Contributor

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
Copy link
Contributor

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

Cellaryllis pushed a commit that referenced this pull request Apr 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants