Unexpected warning when URL of server object is relative URL

[VcamX]

severs:
  - url: /v1

In SwaggerParseResult, I saw message "attribute .servers. invalid url: /v1 ".

Wonder if relative URL is not supported anymore.

Thanks!

[VcamX]

@gracekarina

[VcamX]

From OpenAPI specs and Swagger doc:

REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.

Found the related PR is #1301 and it's introduced since v2.0.18. There's also a change in #1412 for RelativeReferenceTest. It replaced the relative URL with absolute URL.

[r-sreesaran]

The changes has been rolled back.
please do check #1329
Also do try with the latest version of parser.

[VcamX]

The changes has been rolled back.
please do check #1329
Also do try with the latest version of parser.

Thanks for your reply!

The issue doesn't seem to be resolved. I tried with latest release v2.0.24 but still saw the warning. A similar issue is also mentioned on #1329 (comment)

I don't see any error/exception but this warning actually. So the point (i think) is if the warning here is appropriate: https://github.com/swagger-api/swagger-parser/blob/master/modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java#L429
Based on OpenAPI specs and Swagger doc, the URL / is valid. And the warning is put into parsing result SwaggerParseResult. This can be misleading imho.

[r-sreesaran]

As you said having relative url is valid and it should not throw an warning.

[boagm]

Hi

I think I'm also hitting this issue, when I grab https://petstore3.swagger.io/api/v3/openapi.json which has

servers url | "/api/v3"

and I parse it via

      ParseOptions options = new ParseOptions();
      options.setResolve(true);
      options.setResolveFully(true);
      SwaggerParseResult res = openAPIV3Parser.readLocation(docPath,null, options);

with swagger-parser-v3-2.0.24.jar res.getMessages() shows String index out of range: 0
and res.getOpenAPI() is null.

If I rollback back to swagger-parser-v3-2.0.17.jar, we're all good.

Thanks

[gracekarina]

Hi, @boagm, @VcamX , I have tested with current snapshot of Swagger-Parser, and this is not an issue, I will commit a test to show you.
Thanks for reporting this.

[VcamX]

@gracekarina Thanks for your reply! Have you tried with local OpenAPI schema file instead of the one is served on the server? In my use case I have to package the schema file in jar.
@boagm wonder if you put the schema file in jar or on a remote location.