feat: display format for oneOf primitive arms#1230
Closed
jwulf wants to merge 1 commit intoPaloAltoNetworks:mainfrom
Closed
feat: display format for oneOf primitive arms#1230jwulf wants to merge 1 commit intoPaloAltoNetworks:mainfrom
jwulf wants to merge 1 commit intoPaloAltoNetworks:mainfrom
Conversation
|
Would love this to be merged, running into the same issue. |
|
Visit the preview URL for this PR (updated for commit 5353991): https://docusaurus-openapi-36b86--pr1230-2kwerttl.web.app (expires Thu, 06 Nov 2025 16:12:49 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
sserrata
pushed a commit
that referenced
this pull request
Dec 19, 2025
Uses getSchemaName() to properly display format information (e.g.,
'string<date-time>') for primitive arms in oneOf/anyOf schemas, instead
of just showing the raw type ('string').
Closes #1230
Co-authored-by: Josh Wulf <josh.wulf@camunda.com>
4 tasks
omonk
pushed a commit
to omonk/docusaurus-openapi-docs
that referenced
this pull request
Dec 23, 2025
* feat: display format for oneOf primitive arms
Uses getSchemaName() to properly display format information (e.g.,
'string<date-time>') for primitive arms in oneOf/anyOf schemas, instead
of just showing the raw type ('string').
Closes PaloAltoNetworks#1230
Co-authored-by: Josh Wulf <josh.wulf@camunda.com>
* test: add oneOf primitive format types example
Adds test case for oneOf schemas with primitive types that have format
specifiers (e.g., string with date-time, email, integer with int64).
This verifies the fix displays 'string<date-time>' instead of just 'string'.
---------
Co-authored-by: Josh Wulf <josh.wulf@camunda.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
This PR adds display of the format for
oneOfschemas with a primitive arm, in line with the display for the field when it is a direct property.Motivation and Context
oneOfschemas with a primitive arm do not display the format, but display the primitive type only. This impacts enums and specific format strings likedate-time. See this issue for more context and examples.How Has This Been Tested?
This change has been tested by manually verifying the change in output display.
Screenshots (if appropriate)
Example of the output without this patch:
This PR correctly displays the format.
Example of the output when this patch is applied:
Types of changes
Checklist