You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is issue is about a technical point in regards to OpenAPI spec. $ref values should not have any siblings. More information can be found here and here.
Couple of examples of this usage in TOMP-API can be seen here and here.
This usage causes errors with some tools.
Expected Behavior
$ref values should not have any sibling.
Current Behavior
Writing siblings next to $ref causes some tools to throw error when parsing TOMP-API spec.
Possible Solution
As described here, one possible solution is to allOf keyword.
edwinvandenbelt
changed the title
[BUG] or [CHANGE REQUEST] description should not be used next to $ref
[BUG] description should not be used next to $refNov 3, 2020
API Version
1.0
Summary
This is issue is about a technical point in regards to OpenAPI spec.
$ref
values should not have any siblings. More information can be found here and here.Couple of examples of this usage in TOMP-API can be seen here and here.
This usage causes errors with some tools.
Expected Behavior
$ref
values should not have any sibling.Current Behavior
Writing siblings next to
$ref
causes some tools to throw error when parsing TOMP-API spec.Possible Solution
As described here, one possible solution is to
allOf
keyword.So this example can be converted to:
I can create a PR that fixes this, if you agree.
The text was updated successfully, but these errors were encountered: