URLs should be able to contain relative references about redocly-cli

[adamaltman]

I agree that a relative path is valid.

Relative references are resolved using the URLs defined in the Server Object as a Base URI.

I wonder should your url be: "/API/flows/NewCustomer-Flow.html" and can you confirm whatever your server(s) is that your {server url}/API/flows/NewCustomer-Flow.html exists?

[stevenj]

No it actually doesn't exist at the server URL.

Currently there is a disparity between the official spec for OpenAPI3 and how both Redoc2 and Swagger UI render it. The spec says a relative URL should be relative to the servers in the server list. But, at least for the externalDocs: both swagger UI and redoc2 use the URL of the web page embedding the openapi3 viewer as the root (which in my opinion makes more sense). And that's how i am using it in this case.

So if my show_openapi.html is at my-domain.com/api/show_openapi.html
./API/flows/file.html becomes: my-domain.com/api/API/flows/file.html and
/API/flows/file.html becomes: my-domain.com/API/flows/file.html

Neither of which is according to the OpenAPI3 spec, but it is sensible.
Links inside markdown descriptions work the same way.

[knidarkness]

@stevenj , thank you for using openapi-cli. As for now, you can disable the urls validation for the externalDocs using the .redocly.yaml config similar to following:

# apiDefinitions:
# ...  
lint:
# ...  
  rules:
# ...  
    oas3-schema/external-docs:
      url: off
# ...

And we will update the validation rules to support the relative links in relativeDocs & license url's fields.

[stevenj]

Thank you for the workaround, works as expected.