[Bug] Support multiple same-level node types and improve items/array support #397
Conversation
This file contains 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
|
Size Change: +21.9 kB (0%) Total Size: 4.46 MB
ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 2b55d45): https://docusaurus-openapi-36b86--pr397-nr3rt8ms.web.app (expires Fri, 03 Mar 2023 21:44:00 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
sserrata
changed the title
|
Example of how arrays are now rendered in the UI:
|
|
Example of schema with
|
sserrata
force-pushed
the
fix-node-schemas
branch
from
96bf7d0
to
b308dc7
Compare
blindaa121
approved these changes
Feb 2, 2023
There was a problem hiding this comment.
Tested with the following specs to ensure the following:
- No breaking changes were introduced when generating docs via CLI command
- Rendering both Request and Response schemas that included
oneOf+properties Bodycomponent withinApiDemoPanelcontainedoneOfandpropertieswhere applicable
Prisma Access Config
- Addresses
- AddressGroups
- AntiSpywareSignatures
- AntiSpywareProfiles
- ApplicationFilters
- Applications
- AuthenticationProfiles
- Certificates
- DecryptionRules
- DNSSecurityProfiles
- ExternalDynamicLists
- HIPObjects
- IKECryptoProfiles
- IKEGateways
- IPSecCryptoProfiles
- IPSecTunnels
- MFAServers
- QoSPolicyRules
- QoSProfiles
- RadiusServerProfiles
- SCEPProfiles
- Schedules
- Services
- TrafficSteering
- VulnerabilityProtectionProfiles
- VulnerabilityProtectionSignatures
CDL - Log Forwarding
- HTTPSProfiles
SASE - Subscription API
- Instance
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.
Description
Some schemas can implement more than one node type at the same level, such as
oneOfandproperties, or any other combination. This change introduces changes to howcreateNodesprocesses schemas. Previously, there was an ordered precedent applied whereby we exited after the first match. With these changes, now all node types will be collected in an array and returned together, in the order they were processed.Preview: https://docusaurus-openapi-36b86--pr397-nr3rt8ms.web.app/
Motivation and Context
Addresses issue observed in the following endpoint, whereby only the
oneOfschema/node was processed and thepropertieswere ignored: https://pan.dev/access/api/prisma-access-config/post-sse-config-v-1-address-groups/Preview with fix: https://docusaurus-openapi-36b86--pr397-nr3rt8ms.web.app/config/post-sse-config-v-1-address-groups/
How Has This Been Tested?
Tested with the Prisma Access Config
address-groupspec referenced above. Can be found here: https://raw.githubusercontent.com/PaloAltoNetworks/pan.dev/master/openapi-specs/access/prisma-access-config/AddressGroups.yamlAdditional testing is required to ensure no regression bugs are introduced.