Skip to content
This repository has been archived by the owner on Feb 17, 2024. It is now read-only.

Clarify that references to inner elements only apply to JSON Schema / XSD #720

Closed
jstoiko opened this issue Sep 28, 2019 · 0 comments · Fixed by #743
Closed

Clarify that references to inner elements only apply to JSON Schema / XSD #720

jstoiko opened this issue Sep 28, 2019 · 0 comments · Fixed by #743
Milestone

Comments

@jstoiko
Copy link
Contributor

jstoiko commented Sep 28, 2019

The References to Inner Elements section implies that this only applies to JSON and XML schemas, but it's not clear enough.

Proposed clarification

  • change the sentence:

When referencing an inner element of a schema.

to read:

When referencing an inner element of a JSON or XML schema.

  • add a reference to the JSON pointer RFC[1] for references to inner elements of JSON Schemas, i.e. at the end of the list of restrictions add:
  • References pointing to inner elements of JSON schemas MUST be valid JSON Pointers as defined in RFC6901

[1] https://tools.ietf.org/html/rfc6901

@jstoiko jstoiko added this to the v1.0.1 milestone Sep 28, 2019
postatum added a commit to raml-org/raml-tck that referenced this issue Nov 22, 2019
XSD schema pointer are already covered in
tests/raml-1.0/Types/xsdscheme/.

raml-org/raml-spec#720
jstoiko added a commit that referenced this issue Aug 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging a pull request may close this issue.

1 participant