Skip to content

Commit ef6d322

Browse files
committed
Core: move HTTP section into Hypermedia section
1 parent 8c9b183 commit ef6d322

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

jsonschema-core.xml

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -442,29 +442,7 @@
442442
</section>
443443
</section>
444444

445-
<section title="Usage over HTTP">
446-
<t>
447-
When used for hypermedia systems over a network, <xref target="RFC7231">HTTP</xref> is frequently the protocol of choice for distributing schemas. Misbehaved clients can pose problems for server maintainers if they pull a schema over the network more frequently than necessary, when it's instead possible to cache a schema for a long period of time.
448-
</t>
449-
<t>
450-
HTTP servers SHOULD set long-lived caching headers on JSON Schemas. HTTP clients SHOULD observe caching headers and not re-request documents within their freshness period.
451-
</t>
452-
<t>
453-
Clients SHOULD set or prepend a User-Agent header specific to the JSON Schema implementation or software product. Since symbols are listed in decreasing order of significance, the JSON Schema library name/version goes first, then the more generic HTTP library name (if any). For example:
454-
<figure>
455-
<artwork>
456-
<![CDATA[
457-
User-Agent: so-cool-json-schema/1.0.2 curl/7.43.0
458-
]]>
459-
</artwork>
460-
</figure>
461-
</t>
462-
<t>
463-
Clients SHOULD be able to make requests with a "From" header so that server operators can contact the owner of a potentially misbehaving script.
464-
</t>
465-
</section>
466-
467-
<section title="Recommended correlation mechanisms for hypermedia">
445+
<section title="Usage for hypermedia">
468446

469447
<t>
470448
One of the largest adoptors of JSON has been HTTP servers for automated APIs and robots.
@@ -543,7 +521,29 @@ Link: </alice>; rel="profile", </bob>; rel="profile"
543521

544522
</section>
545523

546-
</section>
524+
<section title="Usage over HTTP">
525+
<t>
526+
When used for hypermedia systems over a network, <xref target="RFC7231">HTTP</xref> is frequently the protocol of choice for distributing schemas. Misbehaved clients can pose problems for server maintainers if they pull a schema over the network more frequently than necessary, when it's instead possible to cache a schema for a long period of time.
527+
</t>
528+
<t>
529+
HTTP servers SHOULD set long-lived caching headers on JSON Schemas. HTTP clients SHOULD observe caching headers and not re-request documents within their freshness period.
530+
</t>
531+
<t>
532+
Clients SHOULD set or prepend a User-Agent header specific to the JSON Schema implementation or software product. Since symbols are listed in decreasing order of significance, the JSON Schema library name/version goes first, then the more generic HTTP library name (if any). For example:
533+
<figure>
534+
<artwork>
535+
<![CDATA[
536+
User-Agent: so-cool-json-schema/1.0.2 curl/7.43.0
537+
]]>
538+
</artwork>
539+
</figure>
540+
</t>
541+
<t>
542+
Clients SHOULD be able to make requests with a "From" header so that server operators can contact the owner of a potentially misbehaving script.
543+
</t>
544+
</section>
545+
546+
</section>
547547

548548
<section title="Security considerations">
549549
<t>

0 commit comments

Comments
 (0)