Can't use relative URL to spec.yaml file about redoc HOT 4 OPEN

@sn4kebite sorry for the late reply, I've been busy lately. :(

I'm not quite sure I understand your use case correctly. Could you please elaborate? For what purpose exactly you want to use relative HTTP URL? I mean, if you specify a path on filesystem, the spec would be copied to output directory and relative URL would be used automatically.

from redoc.

Alternatively, in some cases (when only domain is changed), you may use something like:

    'spec': 'http:///api/rest/spec.yaml',

which will try to download the spec from /api/rest/spec.yaml from the same domain.

Please respond whether it worked for you or not.

from redoc.

I am building a docker image containing both API and documentation. The spec.yaml file is not available when the documentation is being built, as it is generated by the API on demand.

From what I understand this is when you want to use an HTTP URL to the spec, however I don't know the URL in advance. The spec can however be found relative to the docs, so using a relative URL in this case solves this problem.

Using the HTTP URL without hostname is a neat trick (I didn't know you could do that), but I'm concerned how well supported it is (no results on google that I could find), and it only works with either http or https.

from redoc.

Using the HTTP URL without hostname is a neat trick (I didn't know you could do that), but I'm concerned how well supported it is (no results on google that I could find),

Well, honestly, I don't know; this is behaviour I observe in Python when you do urljoin.

and it only works with either http or https.

A doubt Redoc.js support any other protocol except for HTTP(s). It's a limitation of JS machines in browsers.

Still I do understand your use case now. I'm thinking about fallbacking to HTTP relative URI if the corresponding file wasn't found. I.e.

• You would still have something like

   'spec': '/api/rest/spec.yaml',

• The extension will try to find a file of filesystem first.

• If found, it will be copied over to output directory.

• If not found, the extension would pass /api/rest/spec.yaml "As Is" to Redoc.js.

from redoc.