CDRW-4743 Fix invalid $ref and description siblings.#193
Draft
cjrobbertse-ob wants to merge 1 commit intov4.0.1-draft-1from
Draft
CDRW-4743 Fix invalid $ref and description siblings.#193cjrobbertse-ob wants to merge 1 commit intov4.0.1-draft-1from
$ref and description siblings.#193cjrobbertse-ob wants to merge 1 commit intov4.0.1-draft-1from
Conversation
…ptions with existing schema definitions.
OBPeteS
requested changes
Nov 11, 2025
Contributor
OBPeteS
left a comment
OBPeteS
left a comment
There was a problem hiding this comment.
This doesn't appear to be based on v4.0 Swagger update 5?
The change was to remove descriptions next to references (and ensure that the description was inside the schema definition) but the PR appears to have added allOf to them instead?
cjrobbertse-ob
changed the title
allOf for combining descri…$ref and description siblings.
Contributor
Author
|
@OBPeteS the issue is that the internal descriptions are sometimes different to the reference description, hence the allOf pattern is used to overwrite the description in that instance of the reference. This pattern has already been used within v4.0.0 Swaggers. |
Contributor
|
As per discussion on Teams - this will be parked until the swagger file work is done outside of v4.0.1 |
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
2 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.
In OAS v3.0.0
$refcannot have direct siblings. So we have usedallOf:'s to ground$refanddescriptionwhich is valid.Jira Ticket: https://openbanking.atlassian.net/browse/CDRW-4743