Skip to content

Commit a333e40

Browse files
committed
Provide guidance on HTTP targetHints
The whole feature is pretty vague, so provide more guidance on what headers are good to use in schemas and support in implementations.
1 parent 0282f4a commit a333e40

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

jsonschema-hyperschema.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,19 @@ GET /foo/
11831183
Approaches shown in that document's examples SHOULD be applied to other
11841184
similarly structured headers wherever possible.
11851185
</t>
1186+
<t>
1187+
It is RECOMMENDED that schema authors provide hints for the values of
1188+
the following types of HTTP headers whenever applicable:
1189+
<list style="symbols">
1190+
<t>Method allowance</t>
1191+
<t>Method-specific request media types</t>
1192+
<t>Authentication challenges</t>
1193+
</list>
1194+
</t>
1195+
<t>
1196+
In general, headers that are likely to have different values at different
1197+
times SHOULD NOT be included in "targetHints".
1198+
</t>
11861199
<t>
11871200
No distinction is made between headers that may appear in responses to
11881201
different methods, such as HEAD vs OPTIONS.

0 commit comments

Comments
 (0)