Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Commit ac82756

Browse files
committed
Update WIP docs
1 parent 6158699 commit ac82756

File tree

4 files changed

+36
-31
lines changed

4 files changed

+36
-31
lines changed

work-in-progress/WIP-jsonschema-core.html

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -473,12 +473,12 @@
473473
<link href="#rfc.authors" rel="Chapter">
474474

475475

476-
<meta name="generator" content="xml2rfc version 2.20.1 - https://tools.ietf.org/tools/xml2rfc" />
476+
<meta name="generator" content="xml2rfc version 2.22.3 - https://tools.ietf.org/tools/xml2rfc" />
477477
<link rel="schema.dct" href="http://purl.org/dc/terms/" />
478478

479479
<meta name="dct.creator" content="Wright, A., Ed., Andrews, H., Ed., Hutton, B., Ed., and G. Dennis" />
480480
<meta name="dct.identifier" content="urn:ietf:id:draft-handrews-json-schema-WIP" />
481-
<meta name="dct.issued" scheme="ISO8601" content="2019-25" />
481+
<meta name="dct.issued" scheme="ISO8601" content="2019-18" />
482482
<meta name="dct.abstract" content="JSON Schema defines the media type &quot;application/schema+json&quot;, a JSON-based format for describing the structure of JSON data. JSON Schema asserts what a JSON document must look like, ways to extract information from it, and how to interact with it. The &quot;application/schema-instance+json&quot; media type provides additional feature-rich integration with &quot;application/schema+json&quot; beyond what can be offered for &quot;application/json&quot; documents. " />
483483
<meta name="description" content="JSON Schema defines the media type &quot;application/schema+json&quot;, a JSON-based format for describing the structure of JSON data. JSON Schema asserts what a JSON document must look like, ways to extract information from it, and how to interact with it. The &quot;application/schema-instance+json&quot; media type provides additional feature-rich integration with &quot;application/schema+json&quot; beyond what can be offered for &quot;application/json&quot; documents. " />
484484

@@ -502,7 +502,7 @@
502502
<td class="right">H. Andrews, Ed.</td>
503503
</tr>
504504
<tr>
505-
<td class="left">Expires: November 26, 2019</td>
505+
<td class="left">Expires: December 20, 2019</td>
506506
<td class="right">Riverbed Technology</td>
507507
</tr>
508508
<tr>
@@ -519,7 +519,7 @@
519519
</tr>
520520
<tr>
521521
<td class="left"></td>
522-
<td class="right">May 25, 2019</td>
522+
<td class="right">June 18, 2019</td>
523523
</tr>
524524

525525

@@ -539,7 +539,7 @@ <h1 id="rfc.status"><a href="#rfc.status">Status of This Memo</a></h1>
539539
<p>This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.</p>
540540
<p>Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.</p>
541541
<p>Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."</p>
542-
<p>This Internet-Draft will expire on November 26, 2019.</p>
542+
<p>This Internet-Draft will expire on December 20, 2019.</p>
543543
<h1 id="rfc.copyrightnotice"><a href="#rfc.copyrightnotice">Copyright Notice</a></h1>
544544
<p>Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved.</p>
545545
<p>This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.</p>
@@ -1078,11 +1078,12 @@ <h1 id="rfc.section.8.1">
10781078
<a href="#rfc.section.8.1">8.1.</a> Initial Base URI</h1>
10791079
<p><a href="#RFC3986" class="xref">RFC3986 Section 5.1</a> defines how to determine the default base URI of a document. </p>
10801080
<p id="rfc.section.8.1.p.2">Informatively, the initial base URI of a schema is the URI at which it was found, whether that was a network location, a local filesystem, or any other situation identifiable by a URI of any known scheme. </p>
1081-
<p id="rfc.section.8.1.p.3">If no source is known, or no URI scheme is known for the source, a suitable implementation-specific default URI MAY be used as described in <a href="#RFC3986" class="xref">RFC 3986 Section 5.1.4</a>. It is RECOMMENDED that implementations document any default base URI that they assume. </p>
1081+
<p id="rfc.section.8.1.p.3">If a schema document defines no explicit base URI with "$id" (embedded in content), the base URI is that determined per <a href="#RFC3986" class="xref">RFC 3986 section 5</a>. </p>
1082+
<p id="rfc.section.8.1.p.4">If no source is known, or no URI scheme is known for the source, a suitable implementation-specific default URI MAY be used as described in <a href="#RFC3986" class="xref">RFC 3986 Section 5.1.4</a>. It is RECOMMENDED that implementations document any default base URI that they assume. </p>
10821083
<h1 id="rfc.section.8.2">
10831084
<a href="#rfc.section.8.2">8.2.</a> <a href="#id-keyword" id="id-keyword">The "$id" Keyword</a>
10841085
</h1>
1085-
<p id="rfc.section.8.2.p.1">The "$id" keyword defines a URI for the schema, and the base URI that other URI references within the schema are resolved against. A subschema's "$id" is resolved against the base URI of its parent schema. If no parent sets an explicit base with "$id", the base URI is that of the entire document, as determined per <a href="#RFC3986" class="xref">RFC 3986 section 5</a>. </p>
1086+
<p id="rfc.section.8.2.p.1">The "$id" keyword defines a URI for the schema, and the base URI that other URI references within the schema are resolved against. A subschema's "$id" is resolved against the base URI of its parent schema. If no parent schema defines an explicit base URI with "$id", the base URI is that of the entire document, as determined per <a href="#RFC3986" class="xref">RFC 3986 section 5</a>. </p>
10861087
<p id="rfc.section.8.2.p.2">If present, the value for this keyword MUST be a string, and MUST represent a valid <a href="#RFC3986" class="xref">URI-reference</a>. This value SHOULD be normalized, and SHOULD NOT be an empty fragment &lt;#&gt; or an empty string &lt;&gt;. </p>
10871088
<h1 id="rfc.section.8.2.1">
10881089
<a href="#rfc.section.8.2.1">8.2.1.</a> Identifying the root schema</h1>
@@ -1718,7 +1719,7 @@ <h1 id="rfc.section.12.4">
17181719
<li>There are only two vertices, but three are required. </li>
17191720
</ul>
17201721

1721-
<p> Note that neither the error message property nor its wording as depicted in these examples is not a requirement of this specification. Implementations SHOULD craft error messages tailored for their audience. </p>
1722+
<p> Note that the error message wording as depicted in these examples is not a requirement of this specification. Implementations SHOULD craft error messages tailored for their audience or provide a templating mechanism that allows their users to craft their own messages. </p>
17221723
<h1 id="rfc.section.12.4.1">
17231724
<a href="#rfc.section.12.4.1">12.4.1.</a> Flag</h1>
17241725
<p id="rfc.section.12.4.1.p.1">In the simplest case, merely the boolean result for the "valid" valid property needs to be fulfilled. </p>
@@ -1746,21 +1747,21 @@ <h1 id="rfc.section.12.4.2">
17461747
{
17471748
"keywordLocation": "#/items/$ref",
17481749
"absoluteKeywordLocation":
1749-
"http://example.com/polygon#/definitions/point",
1750+
"http://example.com/polygon#/$defs/point",
17501751
"instanceLocation": "#/1",
17511752
"error": "A subschema had errors."
17521753
},
17531754
{
17541755
"keywordLocation": "#/items/$ref/required",
17551756
"absoluteKeywordLocation":
1756-
"http://example.com/polygon#/definitions/point/required",
1757+
"http://example.com/polygon#/$defs/point/required",
17571758
"instanceLocation": "#/1",
17581759
"error": "Required property 'y' not found."
17591760
},
17601761
{
17611762
"keywordLocation": "#/items/$ref/additionalProperties",
17621763
"absoluteKeywordLocation":
1763-
"http://example.com/polygon#/definitions/point/additionalProperties",
1764+
"http://example.com/polygon#/$defs/point/additionalProperties",
17641765
"instanceLocation": "#/1/z",
17651766
"error": "Additional property 'z' found but was invalid."
17661767
},
@@ -1796,22 +1797,22 @@ <h1 id="rfc.section.12.4.3">
17961797
"valid": false,
17971798
"keywordLocation": "#/items/$ref",
17981799
"absoluteKeywordLocation":
1799-
"http://example.com/polygon#/definitions/point",
1800+
"http://example.com/polygon#/$defs/point",
18001801
"instanceLocation": "#/1",
18011802
"errors": [
18021803
{
18031804
"valid": false,
18041805
"keywordLocation": "#/items/$ref/required",
18051806
"absoluteKeywordLocation":
1806-
"http://example.com/polygon#/definitions/point/required",
1807+
"http://example.com/polygon#/$defs/point/required",
18071808
"instanceLocation": "#/1",
18081809
"error": "Required property 'y' not found."
18091810
},
18101811
{
18111812
"valid": false,
18121813
"keywordLocation": "#/items/$ref/additionalProperties",
18131814
"absoluteKeywordLocation":
1814-
"http://example.com/polygon#/definitions/point/additionalProperties",
1815+
"http://example.com/polygon#/$defs/point/additionalProperties",
18151816
"instanceLocation": "#/1/z",
18161817
"error": "Additional property 'z' found but was invalid."
18171818
}
@@ -2088,7 +2089,7 @@ <h1 id="rfc.appendix.B">
20882089
<dt>draft-handrews-json-schema-WIP</dt>
20892090
<dd style="margin-left: 8">
20902091
<ul>
2091-
<li>Update to RFC 8359 for JSON specification</li>
2092+
<li>Update to RFC 8259 for JSON specification</li>
20922093
<li>Moved "definitions" from the Validation specification here as "$defs"</li>
20932094
<li>Moved applicator keywords from the Validation specification as their own vocabulary</li>
20942095
<li>Moved the schema form of "dependencies" from the Validation specification as "dependentSchemas"</li>
@@ -2252,6 +2253,8 @@ <h1 id="rfc.authors"><a href="#rfc.authors">Authors' Addresses</a></h1>
22522253
</span>
22532254
<span class="vcardline">EMail: <a href="mailto:[email protected]">[email protected]</a></span>
22542255

2256+
<span class="vcardline">URI: <a href="https://jsonschema.dev">https://jsonschema.dev</a></span>
2257+
22552258
</address>
22562259
</div><div class="avoidbreak">
22572260
<address class="vcard">

work-in-progress/WIP-jsonschema-hyperschema.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -449,12 +449,12 @@
449449
<link href="#rfc.authors" rel="Chapter">
450450

451451

452-
<meta name="generator" content="xml2rfc version 2.20.1 - https://tools.ietf.org/tools/xml2rfc" />
452+
<meta name="generator" content="xml2rfc version 2.22.3 - https://tools.ietf.org/tools/xml2rfc" />
453453
<link rel="schema.dct" href="http://purl.org/dc/terms/" />
454454

455455
<meta name="dct.creator" content="Andrews, H., Ed. and A. Wright, Ed." />
456456
<meta name="dct.identifier" content="urn:ietf:id:draft-handrews-json-schema-hyperschema-WIP" />
457-
<meta name="dct.issued" scheme="ISO8601" content="2019-25" />
457+
<meta name="dct.issued" scheme="ISO8601" content="2019-18" />
458458
<meta name="dct.abstract" content="JSON Schema is a JSON-based format for describing JSON data using various vocabularies. This document specifies a vocabulary for annotating JSON documents with hyperlinks. These hyperlinks include attributes describing how to manipulate and interact with remote resources through hypermedia environments such as HTTP, as well as determining whether the link is usable based on the instance value. The hyperlink serialization format described in this document is also usable independent of JSON Schema. " />
459459
<meta name="description" content="JSON Schema is a JSON-based format for describing JSON data using various vocabularies. This document specifies a vocabulary for annotating JSON documents with hyperlinks. These hyperlinks include attributes describing how to manipulate and interact with remote resources through hypermedia environments such as HTTP, as well as determining whether the link is usable based on the instance value. The hyperlink serialization format described in this document is also usable independent of JSON Schema. " />
460460

@@ -478,8 +478,8 @@
478478
<td class="right">A. Wright, Ed.</td>
479479
</tr>
480480
<tr>
481-
<td class="left">Expires: November 26, 2019</td>
482-
<td class="right">May 25, 2019</td>
481+
<td class="left">Expires: December 20, 2019</td>
482+
<td class="right">June 18, 2019</td>
483483
</tr>
484484

485485

@@ -499,7 +499,7 @@ <h1 id="rfc.status"><a href="#rfc.status">Status of This Memo</a></h1>
499499
<p>This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.</p>
500500
<p>Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.</p>
501501
<p>Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."</p>
502-
<p>This Internet-Draft will expire on November 26, 2019.</p>
502+
<p>This Internet-Draft will expire on December 20, 2019.</p>
503503
<h1 id="rfc.copyrightnotice"><a href="#rfc.copyrightnotice">Copyright Notice</a></h1>
504504
<p>Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved.</p>
505505
<p>This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.</p>

work-in-progress/WIP-jsonschema-validation.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -443,12 +443,12 @@
443443
<link href="#rfc.authors" rel="Chapter">
444444

445445

446-
<meta name="generator" content="xml2rfc version 2.20.1 - https://tools.ietf.org/tools/xml2rfc" />
446+
<meta name="generator" content="xml2rfc version 2.22.3 - https://tools.ietf.org/tools/xml2rfc" />
447447
<link rel="schema.dct" href="http://purl.org/dc/terms/" />
448448

449449
<meta name="dct.creator" content="Wright, A., Ed., Andrews, H., Ed., Hutton, B., Ed., and G. Luff" />
450450
<meta name="dct.identifier" content="urn:ietf:id:draft-handrews-json-schema-validation-WIP" />
451-
<meta name="dct.issued" scheme="ISO8601" content="2019-25" />
451+
<meta name="dct.issued" scheme="ISO8601" content="2019-18" />
452452
<meta name="dct.abstract" content="JSON Schema (application/schema+json) has several purposes, one of which is JSON instance validation. This document specifies a vocabulary for JSON Schema to describe the meaning of JSON documents, provide hints for user interfaces working with JSON data, and to make assertions about what a valid document must look like. " />
453453
<meta name="description" content="JSON Schema (application/schema+json) has several purposes, one of which is JSON instance validation. This document specifies a vocabulary for JSON Schema to describe the meaning of JSON documents, provide hints for user interfaces working with JSON data, and to make assertions about what a valid document must look like. " />
454454

@@ -472,7 +472,7 @@
472472
<td class="right">H. Andrews, Ed.</td>
473473
</tr>
474474
<tr>
475-
<td class="left">Expires: November 26, 2019</td>
475+
<td class="left">Expires: December 20, 2019</td>
476476
<td class="right">Riverbed Technology</td>
477477
</tr>
478478
<tr>
@@ -489,7 +489,7 @@
489489
</tr>
490490
<tr>
491491
<td class="left"></td>
492-
<td class="right">May 25, 2019</td>
492+
<td class="right">June 18, 2019</td>
493493
</tr>
494494

495495

@@ -509,7 +509,7 @@ <h1 id="rfc.status"><a href="#rfc.status">Status of This Memo</a></h1>
509509
<p>This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.</p>
510510
<p>Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.</p>
511511
<p>Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."</p>
512-
<p>This Internet-Draft will expire on November 26, 2019.</p>
512+
<p>This Internet-Draft will expire on December 20, 2019.</p>
513513
<h1 id="rfc.copyrightnotice"><a href="#rfc.copyrightnotice">Copyright Notice</a></h1>
514514
<p>Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved.</p>
515515
<p>This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.</p>
@@ -1066,7 +1066,7 @@ <h1 id="rfc.references.1">
10661066
<tr>
10671067
<td class="reference"><b id="json-schema">[json-schema]</b></td>
10681068
<td class="top">
1069-
<a>Wright, A.</a> and <a>H. Andrews</a>, "<a href="https://tools.ietf.org/html/draft-handrews-json-schema-02">JSON Schema: A Media Type for Describing JSON Documents</a>", Internet-Draft draft-handrews-json-schema-WIP, November 2017.</td>
1069+
<a>Wright, A.</a> and <a>H. Andrews</a>, "<a href="https://tools.ietf.org/html/draft-handrews-json-schema-WIP">JSON Schema: A Media Type for Describing JSON Documents</a>", Internet-Draft draft-handrews-json-schema-WIP, November 2017.</td>
10701070
</tr>
10711071
<tr>
10721072
<td class="reference"><b id="relative-json-pointer">[relative-json-pointer]</b></td>
@@ -1352,6 +1352,8 @@ <h1 id="rfc.authors"><a href="#rfc.authors">Authors' Addresses</a></h1>
13521352
</span>
13531353
<span class="vcardline">EMail: <a href="mailto:[email protected]">[email protected]</a></span>
13541354

1355+
<span class="vcardline">URI: <a href="https://jsonschema.dev">https://jsonschema.dev</a></span>
1356+
13551357
</address>
13561358
</div><div class="avoidbreak">
13571359
<address class="vcard">

0 commit comments

Comments
 (0)