fix and test for issue 1758 #1760
Conversation
modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java
Outdated
Show resolved
Hide resolved
modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java
Outdated
Show resolved
Hide resolved
|
@ponelat @frantuma I addressed the comments, and also did the validation in deserializer of examples, and securitySchemes, but not 100% sure it applies here. |
|
@gracekarina Here is an example of using openapi: 3.0.3
info:
title: $ref of an "Example".
version: 1.0.0
paths:
/foo:
get:
description: ok
responses:
'200':
description: ok
content:
application/json:
schema:
type: object
examples:
one:
$ref: '#/components/examples/Ex'
components:
examples:
Ex:
summary: The value one.
value:
one: '1' |
There was a problem hiding this comment.
@gracekarina couple of minor comments, when addressed please merge
| @@ -958,6 +958,9 @@ public PathItem getPathItem(ObjectNode obj, String location, ParseResult result) | |||
| } else { | |||
| pathItem.set$ref(ref.textValue()); | |||
| } | |||
| if(ref.textValue().startsWith("#/components") && !(ref.textValue().startsWith("#/components/pathItems"))) { | |||
| result.warning(location, "$ref target "+ref.textValue() +" is not of expected type"); | |||
There was a problem hiding this comment.
I would detail what is the expected type, like "$ref target "+ref.textValue() +" is not of expected type pathItem");. Same applies to similar code below
| }else { | ||
| parameter.set$ref(ref.textValue()); | ||
| } | ||
| if(ref.textValue().startsWith("#/components") && !(ref.textValue().startsWith("#/components/parameters")||ref.textValue().startsWith("#/components/headers"))) { |
There was a problem hiding this comment.
cdoe style, would replace meters")||ref.textVal with meters") || ref.textVal
| @@ -2115,6 +2127,10 @@ public Header getHeader(ObjectNode headerNode, String location, ParseResult resu | |||
| } else { | |||
| header.set$ref(ref.textValue()); | |||
| } | |||
| if(ref.textValue().startsWith("#/components") && !(ref.textValue().startsWith("#/components/parameters")||ref.textValue().startsWith("#/components/headers"))) { | |||
There was a problem hiding this comment.
cdoe style, would replace meters")||ref.textVal with meters") || ref.textVal
Fix and test for issue #1758.
Adds a validation message for parameters and headers when ref field in internal references are not being pointed at the right components tag.