Skip to content

Commit b1e8cac

Browse files
decentralgabemspornyandresuribe87
authored
Address normative references issues (#216)
* address issue comments * Apply suggestions from code review Co-authored-by: Manu Sporny <[email protected]> * pr comments * Apply suggestions from code review Co-authored-by: Andres Uribe <[email protected]> * formatting --------- Co-authored-by: Manu Sporny <[email protected]> Co-authored-by: Andres Uribe <[email protected]>
1 parent 0b4d38e commit b1e8cac

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

index.html

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h2>Data Model</h2>
157157
<a>verifiable credential</a>.
158158
</p>
159159
<p>
160-
Implementers may find use in packaging a JSON Schema as a verifiable credential when they wish to
160+
Implementers MAY package a [[JSON-SCHEMA]] as a <a>verifiable credential</a> when they wish to
161161
leverage features of the [[VC-DATA-MODEL-2.0]], answering questions such as:
162162
<ul>
163163
<li>Who is the author of this schema? (provided by the <code>issuer</code> property)</li>
@@ -496,13 +496,13 @@ <h2>JSON Schema Specifications</h2>
496496
<td>Yes</td>
497497
</tr>
498498
<tr>
499-
<td>[[JSON-SCHEMA-2019-09]]</td>
499+
<td>[[?JSON-SCHEMA-2019-09]]</td>
500500
<td>19 March 2020</td>
501501
<td><a href="https://json-schema.org/draft/2019-09/schema">https://json-schema.org/draft/2019-09/schema</a></td>
502502
<td>No</td>
503503
</tr>
504504
<tr>
505-
<td>[[JSON-SCHEMA-DRAFT-7]]</td>
505+
<td>[[?JSON-SCHEMA-DRAFT-7]]</td>
506506
<td>20 September 2018</td>
507507
<td><a href="http://json-schema.org/draft-07/schema#">http://json-schema.org/draft-07/schema#</a></td>
508508
<td>No</td>
@@ -524,8 +524,9 @@ <h3>Reserved Keywords</h3>
524524
lists these reserved keywords, which can be found in the table provided above.
525525
</p>
526526
<p>
527-
In the upcoming sections we list <i>some</i> keywords that possess unique significance and
528-
should not be used in conflicting ways.
527+
In the upcoming sections we list <i>some</i> keywords that possess unique significance in
528+
[[JSON-SCHEMA]] documents and SHOULD NOT be used in conflicting ways, such as redefining
529+
these keywords, or using them in a manner other than as noted by [[JSON-SCHEMA]] specifications.
529530
</p>
530531
<p>
531532
Furthermore, we identify specific keywords, that are not explicitly defined by JSON Schema,
@@ -534,9 +535,9 @@ <h3>Reserved Keywords</h3>
534535
<section class="normative">
535536
<h4>$id</h4>
536537
<p>
537-
Across JSON Schema specifications, the <code>$id</code> keyword identifies a schema resource
538-
with its canonical [[RFC6596]] URI. The <code>$id</code> MUST be present and its value
539-
MUST represent a valid URI-reference [[RFC3986]].
538+
Across JSON Schema specifications, the <code>$id</code> keyword identifies a schema resource
539+
with its canonical URI. The <code>$id</code> MUST be present, and its value MUST represent
540+
a valid URI-reference as specified by the associated [[JSON-SCHEMA]] version.
540541
</p>
541542
<p>
542543
It is RECOMMENDED that the value of the <code>$id</code> property match the <code>id</code>
@@ -617,8 +618,8 @@ <h3>Integrity Validation</h3>
617618
<p>
618619
Credential Schemas MAY be packaged as <a>verifiable credentials</a> as defined
619620
by usage of the <a href="#jsonschemacredential">JsonSchemaCredential</a> type.
620-
The credential containing a <a>credential schema</a> may include a proof, either
621-
embedded according to <a data-cite="VC-DATA-MODEL-2.0/#securing-verifiable-credentials">
621+
The credential containing a <a>credential schema</a> MAY be secured by using either an
622+
embedded or external proof as defined in <a data-cite="VC-DATA-MODEL-2.0/#securing-verifiable-credentials">
622623
Securing Verifiable Credentials</a>.
623624
</p>
624625
<p>
@@ -760,7 +761,7 @@ <h4>Failure Result</h4>
760761
<section>
761762
<h4>Indeterminate Result</h4>
762763
<p>
763-
Assuming that the implementer does not support [[JSON-SCHEMA-2019-09]], an example of an <i>Indeterminate</i>
764+
Assuming that the implementer does not support [[?JSON-SCHEMA-2019-09]], an example of an <i>Indeterminate</i>
764765
evaluation is provided below.
765766
</p>
766767
<p>
@@ -1274,24 +1275,27 @@ <h3>Media Types</h3>
12741275
<section id="media-types-for-jsonschema">
12751276
<h2><code>JsonSchema</code></h2>
12761277
<p>
1277-
This specification acknowledges the use of the <code>application/schema+json</code>
1278-
and <code>application/json</code> Media Types specifically for identifying a [[JSON-SCHEMA]]
1279-
with usage of the <a href="#jsonschema">JsonSchema</a> type, as registered in
1280-
<a href="#json-schema-specifications">JSON Schema specifications</a>.
1278+
The media type <code>application/schema+json</code>, as defined in
1279+
[[JSON-SCHEMA]], SHOULD be used when transmitting a [[JSON-SCHEMA]] expressed
1280+
as JSON over HTTP. Clients receiving [[JSON-SCHEMA]] files over HTTP MAY accept content
1281+
using either the <code>application/schema+json</code> media type or the
1282+
<code>application/json</code> media type as defined in [[JSON]].
12811283
</p>
12821284
<p>
12831285
When using the <a href="#jsonschema">JsonSchema</a> type with a [[YAML]]
1284-
representation of a [[JSON-SCHEMA]], defined by [[[OPENAPIS-3.1.0]]], the types <code>application/openapi+yaml</code>
1285-
or <code>application/yaml</code> may be used.
1286+
representation of a [[JSON-SCHEMA]], defined by [[[OPENAPIS-3.1.0]]], the types
1287+
<code>application/openapi+yaml</code> or <code>application/yaml</code> MAY be used.
12861288
</p>
12871289
</section>
12881290
<section class="normative" id="media-types-for-jsonschemacredential">
12891291
<h2><code>JsonSchemaCredential</code></h2>
12901292
<p>
1291-
This specification acknowledges the use of the <code>application/vc+ld+json</code>,
1292-
<code>application/vc+ld+json+jwt</code>, and <code>application/vc+ld+json+sd-jwt</code> Media Types
1293-
specifically for identifying a [[JSON-SCHEMA]] with usage of the <a href="#jsonschemacredential">
1294-
JsonSchemaCredential</a> type, as registered in the [[VC-DATA-MODEL-2.0]], [[VC-JOSE-COSE]], and [[SD-JWT]] specifications respectively.
1293+
The media types <code>application/vc+ld+json</code>, <code>application/vc+ld+json+jwt</code>, or
1294+
<code>application/vc+ld+json+sd-jwt</code> as defined in [[VC-DATA-MODEL-2.0]],
1295+
[[VC-JOSE-COSE]], or [[SD-JWT]] specifications, respectively, SHOULD be used when
1296+
transmitting a [[JSON-SCHEMA]] represented as a <a>verifiable credential</a> with usage of
1297+
the <a href="#jsonschema">JsonSchemaCredential</a> type. Clients receiving <a>credential schemas</a>
1298+
files over HTTP MAY accept content using any of these types.
12951299
</p>
12961300
</section>
12971301
</section>

0 commit comments

Comments
 (0)