[FOLIO-1399] Improve lint-raml to handle RMB v20+ schema $ref as key names Created: 06/Aug/18 Updated: 12/Nov/18 Resolved: 16/Aug/18 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | Task | Priority: | P3 |
| Reporter: | David Crossley | Assignee: | David Crossley |
| Resolution: | Done | Votes: | 0 |
| Labels: | ci, core, raml, sprint44 | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Issue links: |
|
||||||||||||||||||||||||||||||||
| Sprint: | |||||||||||||||||||||||||||||||||
| Description |
|
The script folio-tools/lint-raml/lint_raml_cop.py does already handle "RAML 1.0" as well as "RAML 0.8". The new RMB v20 (
Its dependencies still utilise the schema key names declared in the RAML files as the $ref value to link a parent JSON schema to another schema. However now it does not allow those $ref values to be a filename or relative pathname. So the lint_raml_cop.py independent verification script needs to continue to handle our previous style of $ref using pathnames (
|
| Comments |
| Comment by Mike Taylor [ 06/Aug/18 ] |
|
If I rightly understand the implications here, we are actively moving away from what the JSON Schema standards specifies. And this means that our actual JSON Schemas are likely to become more and more standards-non-conformant, which means that mod-graphl's JSON Schema handling code won't be able to use standard tools. Am I missing something? |
| Comment by David Crossley [ 07/Aug/18 ] |
|
This is the way that the RMB’s dependencies (raml-for-jax-rs and jsonschema2pojo) operate – an implementation-specific technique. This is the way that it was with the original RMB because of those dependencies. Then with
There are some comments in
This
|
| Comment by Jakub Skoczen [ 08/Aug/18 ] |
|
Guys, (adding Adam Dickmeiss) I wonder if we should investigate if it's possible to patch the library to allow $ref linking that is compliant with the JSON schema standard. |
| Comment by Adam Dickmeiss [ 16/Aug/18 ] |
|
I don't think we need to do this anymore.. At least I can get stock raml-cop to pass RAML files with
|
| Comment by David Crossley [ 16/Aug/18 ] |
|
After the
|