Fix oneOf + required rendering issues - #692
Merged
PatStLouis merged 2 commits intoSep 1, 2026
Merged
Conversation
… with required in the same pattern as ExchangeParticipationClientMessage to resolve rendering issues without respec-oas update
eric-schuh
requested review from
PatStLouis,
TallTed,
dlongley and
msporny
as code owners
August 4, 2026 19:05
Collaborator
|
discussed: we should favor the OAS accuracy, rendered OAS comes second. Lets review the semantics of the data models to ensure they are representative of the expected request/response bodies. |
Collaborator
|
@eric-schuh Does PR #706 obviate this PR (you mentioned that it overrides PR #691, but not sure if it does the same for this PR)? |
Collaborator
|
discussed: Merge this as is and then review the spec holistically for pattern alignment based on the following observation Investigate the possible duplication related to |
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
4 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.
This PR attempts to address #605 which details how OAS components that make use of both oneOf and required were not being rendered correctly.
To fix, the oas.yaml was updated for the IssueRequests and OpenIDClientProfile components were updated to match the pattern of oneOf+required found in the ExchangeParticipationClientMessage component. I don't believe that these changes modify the underlying meaning of the OAS for these components but I would be nice to have that double checked.
As part of this the IssueRequests:credentialTemplateIndex property was updated from the type: "number" to type: "string". This was primarily because I could not find any other instance of type: "number" being used. If we want to keep this as type: "number" a respec-oas update will be needed as currently it has no case handling for "number" types.
To fix this in other ways, changes to respec-oas will be needed. Currently this PR is not dependent on any respec-oas changes.