Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move the $ref links to relative urls #23

Closed
alamers opened this issue Jun 20, 2019 · 3 comments
Closed

move the $ref links to relative urls #23

alamers opened this issue Jun 20, 2019 · 3 comments

Comments

@alamers
Copy link
Collaborator

alamers commented Jun 20, 2019

Currently the $ref's are absolute URL's pointing to the adewg's master branch. This makes it hard to test and verify in other repositories.

We should check if we can simply make them relative to the (example) url scheme.

@cookeac
Copy link
Collaborator

cookeac commented Jul 31, 2019

Relative URLs can work well for JSON Schema (at least for me using VS Code and the ES Lint plug-in etc), but this is not necessarily the case for all parsers and validators. Some developers may need to be explicit in their parameters to their parser/validator to a) have it load referenced schemas and b) provide the paths in which the parser/validator should look for those referenced schemas.
I will ask other methods of our team here about use with OpenAPI/Swagger.

@cookeac
Copy link
Collaborator

cookeac commented Jul 31, 2019

@cookeac
Copy link
Collaborator

cookeac commented Aug 7, 2019

Summarising the out-of-band email conversation here between Arjan, Erwin, and I:

a. The $refs have now all been made relative.
b. Swagger Editor has some problems with these.

You can open the url scheme if you provide a URL parameter:
Open the editor with: http://editor.swagger.io/?url=https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json
This will allow the editor to resolve all relative url’s based on the given URL parameter.

Arjan has added this URL to the Wiki pages as well:
https://github.com/adewg/ICAR/wiki/Implementing-a-client-application
https://github.com/adewg/ICAR/wiki/Implementing-a-service

Closing this issue as complete (reopen if you disagee).

@cookeac cookeac closed this as completed Aug 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants