feat: add CLI flag for schema-only doc generation #36
+1,040
−153
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rks#1248) * Fix nested anyOf/oneOf schema rendering with lazy tabs and proper spacing - Add lazy rendering to SchemaTabs to ensure only selected tab content is rendered - Generate unique IDs for each anyOf/oneOf tab group to prevent value collisions - Add fallback labels for schemas without title or type - Support implicit object types (schemas with properties but no explicit type: object) - Add proper spacing (1rem) between badges and tabs, and after tab containers Fixes rendering issues where: - All tab contents were visible simultaneously regardless of selection - Nested oneOf schemas weren't displaying correctly - Tab selection wasn't properly isolated - Visual spacing was missing between badges and tabs * Add test case for nested anyOf/oneOf with properties at same level Adds /anyof-nested-oneof-with-properties test operation that demonstrates: - anyOf containing multiple oneOf arrays - oneOf schemas with properties but no explicit type: object - Schema with both oneOf and properties at the same level (layer3) - Complex nesting similar to ethernet-interfaces schema This test case validates the fixes for lazy tab rendering, unique tab IDs, and proper handling of implicit object types.
* Fix rendering of allOf with multiple oneOf/anyOf constraints - Detect when allOf contains multiple oneOf/anyOf items - Render each constraint separately instead of merging (which loses information) - Display oneOf/anyOf constraints before shared properties - Fixes issue where nested oneOf schemas were not properly rendered in security-rules schema * Add test case for allOf with multiple oneOf constraints - Demonstrates allOf containing two independent oneOf groups - Shows realistic pattern where object must satisfy multiple constraints - Includes shared properties that apply to all combinations - Tests the fix for rendering multiple oneOf items within allOf
Updated yarn install command to use --frozen-lockfile option for consistency and to prevent unintended changes to the yarn.lock file.
…toNetworks#1256) - Update the placeholder assignment logic to use find method for better accuracy. - Ensure the correct name is retrieved based on the key from authOptions.
…questTimeout (PaloAltoNetworks#1267) * feat(theme): improve error handling for API requests - Add custom RequestError class with typed error categories (timeout, network, cors, unknown) - Replace Promise.race timeout with AbortController for cleaner timeout handling - Add descriptive error messages for different failure scenarios - Add translation IDs for internationalization of error messages - Update Request component to display context-specific error messages * feat(theme): add configurable request timeout and site-wide proxy support - Increase default request timeout from 5s to 30s - Add requestTimeout option to themeConfig.api for site-wide configuration - Support proxy in themeConfig.api as site-wide default (per-spec plugin option takes precedence) - Update documentation in README.md, plugin README.md, and intro.mdx
- Add --schemas-only option to clean-api-docs command - Add --schemas-only option to clean-api-docs:version command - When --schemas-only is used, only the schemas/ directory is cleaned - API, info, tag docs and sidebar files are left untouched - Update documentation in all README files
sserrata
force-pushed
the
codex/implement-cli-command-for-schema-generation
branch
from
013a591 to
ae2af54
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
--schemas-onlyflag to thegen-api-docsandgen-api-docs:versioncommands and skip sidebar generation when it is usedshowSchemasis disabled, and cover the behavior with a testTesting
https://chatgpt.com/codex/tasks/task_e_68d176ea1eb4832386ce1f558e0a7d7e