Skip to content

Rename some href* keywords to template* #420

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 8, 2017
Merged

Rename some href* keywords to template* #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b01c13a
Rename some href* keywords to template*
handrews Sep 23, 2017
884b964
Update links.json for href* to template* rename.
handrews Sep 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions jsonschema-hyperschema.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@
sub-instance that validated against the schema containing the LDO.
</t>
<t>
<xref target="hrefPointers">"hrefPointers"</xref> allows adjusting
<xref target="templatePointers">"templatePointers"</xref> allows adjusting
the location from which instance data is resolved on a per-variable
basis.
</t>
Expand Down Expand Up @@ -550,18 +550,18 @@
express a requirement for those variables that can be supplied via input,
some variables must be resolved from instance data. When that instance
data is not required by the context schema, the
<xref target="hrefRequired">"hrefRequired</xref> keyword may be used to
indicate that when the instance data is not available, the link does
not apply.
<xref target="templateRequired">"templateRequired</xref> keyword may
be used to indicate that when the instance data is not available, the
link does not apply.
</t>
</section>
</section>

</section>

<section title="hrefPointers" anchor="hrefPointers">
<section title="templatePointers" anchor="templatePointers">
<t>
The value of the "hrefPointers" link description property MUST be
The value of the "templatePointers" link description property MUST be
an object. Each property value in the object MUST be a valid
<xref target="RFC6901">JSON Pointer</xref>, or a valid
<xref target="I-D.luff-relative-json-pointer">Relative JSON Pointer</xref>
Expand Down Expand Up @@ -596,26 +596,26 @@
{
"rel": "self",
"href": "/trees/{rootId}/nodes/{id}",
"hrefPointers": {
"templatePointers": {
"rootId": "/id"
}
},
{
"rel": "up",
"href": "/trees/{rootId}/nodes/{parentId}",
"hrefPointers": {
"templatePointers": {
"rootId": "/id",
"parentId": "2/id"
},
"hrefRequired": ["parentId"]
"templateRequired": ["parentId"]
}
]
}]]>
</artwork>
</figure>
<t>
In "self" link, the context node's id resolves with the standard process and
therefore does not appear in "hrefPointers". In both "self" and "up" links,
therefore does not appear in "templatePointers". In both "self" and "up" links,
the root id is located using an absolute JSON Pointer. Finally, in "up" link,
the parent node uses a Relative JSON Pointer, going up two levels (one level up
is the array of children, two levels up is the whole parent node), and then
Expand Down Expand Up @@ -659,7 +659,7 @@
</t>
<t>
For the root node, the relative pointer for the parent doesn't point
to anything, so <xref target="hrefRequired">"hrefRequired"</xref>
to anything, so <xref target="templateRequired">"templateRequired"</xref>
prevents the link from being used with that node.
</t>
</section>
Expand Down Expand Up @@ -755,7 +755,7 @@
</t>
</section>

<section title="hrefRequired" anchor="hrefRequired">
<section title="templateRequired" anchor="templateRequired">
<t>
The value of this keyword MUST be an array, and the elements MUST be unique.
Each element SHOULD match a variable in the link's URI Template, without
Expand All @@ -766,21 +766,21 @@
<figure>
<preamble>
Here is a simplified version of the "up" link from the
<xref target="hrefPointers">"hrefPointers</xref> tree example,
<xref target="templatePointers">"templatePointers</xref> tree example,
modified to only use the parent identifier for its "href" template.
While each individual node is required to have an "id" field, the
"up" link uses the parent node's field, and the root node, by definition,
does not have a parent node. Putting "parentId" in "hrefRequired" ensures
that the "up" link is correctly unusable with the root node.
does not have a parent node. Putting "parentId" in "templateRequired"
ensures that the "up" link is correctly unusable with the root node.
</preamble>
<artwork>
<![CDATA[{
"rel": "up",
"href": "/nodes/{parentId}",
"hrefPointers": {
"templatePointers": {
"parentId": "2/id"
},
"hrefRequired": ["parentId"]
"templateRequired": ["parentId"]
}]]>
</artwork>
</figure>
Expand Down
4 changes: 2 additions & 2 deletions links.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"type": "string",
"format": "uri-template"
},
"hrefPointers": {
"templatePointers": {
"type": "object",
"additionalProperties": {
"type": "string",
Expand All @@ -24,7 +24,7 @@
{ "$ref": "http://json-schema.org/draft-06/hyper-schema#" }
]
},
"hrefRequired": {
"templateRequired": {
"type": "array",
"items": {
"type": "string"
Expand Down