Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 43d6754

Browse files
committed
Remove "method", URI input with "hrefVars"
In the most recent draft, "method" simply controlled whether link input was placed in the URI (for a value of "get") or in the request body (for a valued of "post"). While correlating with HTML, this was both confusing due to "get" and "post" not necessarily indicating the HTTP methods of the same name, and limiting in that users/clients could not submit data through both the URI and the request body at the same time. This introduces "hrefVars" which provides a schema for user input matching the "href" URI Template variables. It removes "method" and makes "schema" and "encType" unambiguously apply to the request body in all cases. Clients should choose when to use the request body submission based on the rules of the protocol given by the URI scheme and the semantics indicated by the link relation. Additionally, the complex and apparently rarely if ever used preprocessing rules have been removed, and both the resulting and pre-existing limitations have been documented. They will be the subject of work for future drafts. The meta-schemas have been updated accordingly, and the LDO schema has been brought over from the web site repo and updated. Improper use of "$ref" has been fixed with "allOf".
1 parent fac35a0 commit 43d6754

File tree

3 files changed

+243
-175
lines changed

3 files changed

+243
-175
lines changed

‎hyper-schema.json

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"id": "http://json-schema.org/draft/hyper-schema#",
44
"title": "JSON Hyper-Schema",
55
"allOf": [
6-
{"$ref": "http://json-schema.org/draft-04/schema#"}
6+
{"$ref": "http://json-schema.org/draft/schema#"}
77
],
88
"properties": {
99
"additionalItems": {
@@ -48,7 +48,8 @@
4848

4949
"base": {
5050
"description": "URI Template resolved as for the 'href' keyword in the Link Description Object. The resulting URI Reference is resolved against the current URI base and sets the new URI base for URI references within the instance.",
51-
"type": "string"
51+
"type": "string",
52+
"format": "uritemplate"
5253
},
5354
"links": {
5455
"type": "array",
@@ -80,7 +81,12 @@
8081
"properties": {
8182
"href": {
8283
"description": "a URI template, as defined by RFC 6570, with the addition of the ,ドル ( and ) characters for pre-processing",
83-
"type": "string"
84+
"type": "string",
85+
"format": "uritemplate"
86+
},
87+
"hrefVars": {
88+
"description": "a schema for validating user input to the URI template, where the input is in the form of a JSON object with property names matching variable names in \"href\"",
89+
"allOf": [ {"$ref": "#"} ]
8490
},
8591
"rel": {
8692
"description": "relation to the target resource of the link",
@@ -92,24 +98,20 @@
9298
},
9399
"targetSchema": {
94100
"description": "JSON Schema describing the link target",
95-
"$ref": "#"
101+
"allOf": [{"$ref": "#"}]
96102
},
97103
"mediaType": {
98104
"description": "media type (as defined by RFC 2046) describing the link target",
99105
"type": "string"
100106
},
101-
"method": {
102-
"description": "specifies that the client can construct a templated query (\"get\") or non-idempotent request (\"post\") to a resource.",
103-
"type": "string"
104-
},
105107
"encType": {
106-
"description": "The media type in which to submit data along with the request",
108+
"description": "The media type in which to submit data in the request body",
107109
"type": "string",
108110
"default": "application/json"
109111
},
110112
"schema": {
111-
"description": "Schema describing the data to submit along with the request",
112-
"$ref": "#"
113+
"description": "Schema describing the data to submit in the request body"},
114+
"allOf": [{"$ref": "#"}]
113115
}
114116
}
115117
}

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /