You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
These "schema" keyword is too generic of a name given that
there are now three schemas involved in an LDO. Change it to
indicate that it is used for submitting data for processing,
as is done with HTML form submissions.
Rename "encType" to match.
Copy file name to clipboardExpand all lines: jsonschema-hyperschema.xml
+20-15
Original file line number
Diff line number
Diff line change
@@ -390,15 +390,15 @@
390
390
391
391
<sectiontitle="Links and data">
392
392
<t>
393
-
"Form"-like functionality can be defined by use of the <xreftarget="method">"method"</xref> and <xreftarget="schema">"schema"</xref> keywords, which supplies a schema describing the data to supply to the server.
393
+
"Form"-like functionality can be defined by use of the <xreftarget="method">"method"</xref> and <xreftarget="submissionSchema">"submissionSchema"</xref> keywords, which supplies a schema describing the data to supply to the server.
394
394
Functionality equivalent to dynamic URI generation is available through the <xreftarget="href">"href"</xref> template and <xreftarget="hrefSchema">"hrefSchema"</xref>.
395
395
</t>
396
396
<t>
397
-
The simplest kind of link has an "href" with no template variables, and no "schema". This does not
397
+
The simplest kind of link has an "href" with no template variables, and no "submissionSchema". This does not
398
398
allow for any variance in the link URI, nor does it allow for a request document.
399
399
</t>
400
400
<t>
401
-
An "href" with at least one template variable, but no "hrefSchema" or "schema", allows resolving
401
+
An "href" with at least one template variable, but no "hrefSchema" or "submissionSchema", allows resolving
402
402
the template variable from the instance, but does not allow resolving it
403
403
from external data, nor does it allow a request document.
404
404
</t>
@@ -407,7 +407,7 @@
407
407
data to resolve the template, and falls back to resolving any remaining variables from the instance.
408
408
</t>
409
409
<t>
410
-
A link with a "schema" allows submitting external data either as a request body (if "method" is "post"),
410
+
A link with a "submissionSchema" allows submitting external data either as a request body (if "method" is "post"),
411
411
or as a URI query string (if "method" is "get"). Such a query string replaces any query string
412
412
present after the "href" template is resolved.
413
413
</t>
@@ -580,7 +580,7 @@
580
580
<t>
581
581
<cref>
582
582
The above example simulates the behavior found in earlier drafts using only "hrefSchema",
583
-
which would allow the concurrent use of "schema" on a "post" link.
583
+
which would allow the concurrent use of "submissionSchema" on a "post" link.
This property contains a schema which defines the acceptable structure of the document being encoded according to the "encType" property.
973
+
This property contains a schema which defines the acceptable structure of the document being encoded according to the "submissionEncType" property.
974
974
</t>
975
975
976
976
<t>
977
-
Note that this does not define the structure for URI template variables. That is handed by <xreftarget="hrefSchema">"hrefSchema"</xref>. If the method is "get" and the resolved URI Template has a query string, the query string produced by input validated against "schema" replaces the existing query string.
977
+
Note that this does not define the structure for URI template variables. That is handed by <xreftarget="hrefSchema">"hrefSchema"</xref>. If the method is "get" and the resolved URI Template has a query string, the query string produced by input validated against "submissionSchema" replaces the existing query string.
978
978
</t>
979
979
980
980
<t>
981
-
This is a separate concept from the "targetSchema" property, which is describing the target information resource (including for replacing the contents of the resource in a PUT request), unlike "schema" which describes the user-submitted request data to be evaluated by the resource.
981
+
This is a separate concept from the <xreftarget="targetSchema">"targetSchema"</xref> property, which is describing the target information resource (including for replacing the contents of the resource in a PUT request), unlike "submissionSchema" which describes the user-submitted request data to be evaluated by the resource.
982
+
"submissionSchema" is intended for use with requests that have payloads that are not
983
+
defined in terms of the target representation.
982
984
</t>
983
985
</section>
984
986
</section>
@@ -1056,6 +1058,9 @@ GET /foo/
1056
1058
<t>Removed URI Template pre-processing</t>
1057
1059
<t>Clarified how links and data submission work</t>
1058
1060
<t>Clarified how validation keywords apply hyper-schema keywords and links</t>
0 commit comments