Skip to content

Commit

Permalink
Automated build
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 13, 2023
1 parent 05fe1c8 commit e273bce
Show file tree
Hide file tree
Showing 2 changed files with 333 additions and 1,408 deletions.
10 changes: 7 additions & 3 deletions docs/ob_err_v3p0.html
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ <h2>IPR and Distribution Notice</h2>
</p>
</div>
</header>
<section id="abstract" class="introductory"><h2>Abstract</h2></section><nav id="toc"><h2 class="introductory" id="table-of-contents">Table of Contents</h2><ol class="toc"><li class="tocline"><a class="tocxref" href="#abstract">Abstract</a></li><li class="tocline"><a class="tocxref" href="#errata-for-open-badges-3-0-specification"><bdi class="secno">1. </bdi>Errata for Open Badges 3.0 Specification<span class="formerLink" aria-label="§"></span></a><ol class="toc"><li class="tocline"><a class="tocxref" href="#context-file"><bdi class="secno">1.1 </bdi>Context file<span class="formerLink" aria-label="§"></span></a><ol class="toc"><li class="tocline"><a class="tocxref" href="#what-constitutes-a-breaking-change"><bdi class="secno">1.1.1 </bdi>What constitutes a breaking change<span class="formerLink" aria-label="§"></span></a></li><li class="tocline"><a class="tocxref" href="#version-3-0-2"><bdi class="secno">1.1.2 </bdi>version 3.0.2<span class="formerLink" aria-label="§"></span></a></li><li class="tocline"><a class="tocxref" href="#version-3-0-1"><bdi class="secno">1.1.3 </bdi>version 3.0.1<span class="formerLink" aria-label="§"></span></a></li></ol></li></ol></li><li class="tocline"><a class="tocxref" href="#revisionhistory"><bdi class="secno">A. </bdi>Revision History</a></li></ol></nav>
<section id="abstract" class="introductory"><h2>Abstract</h2></section><nav id="toc"><h2 class="introductory" id="table-of-contents">Table of Contents</h2><ol class="toc"><li class="tocline"><a class="tocxref" href="#abstract">Abstract</a></li><li class="tocline"><a class="tocxref" href="#errata-for-open-badges-3-0-specification"><bdi class="secno">1. </bdi>Errata for Open Badges 3.0 Specification<span class="formerLink" aria-label="§"></span></a><ol class="toc"><li class="tocline"><a class="tocxref" href="#context-file"><bdi class="secno">1.1 </bdi>Context file<span class="formerLink" aria-label="§"></span></a><ol class="toc"><li class="tocline"><a class="tocxref" href="#what-constitutes-a-breaking-change"><bdi class="secno">1.1.1 </bdi>What constitutes a breaking change<span class="formerLink" aria-label="§"></span></a></li><li class="tocline"><a class="tocxref" href="#version-3-0-3"><bdi class="secno">1.1.2 </bdi>version 3.0.3<span class="formerLink" aria-label="§"></span></a></li><li class="tocline"><a class="tocxref" href="#version-3-0-2"><bdi class="secno">1.1.3 </bdi>version 3.0.2<span class="formerLink" aria-label="§"></span></a></li><li class="tocline"><a class="tocxref" href="#version-3-0-1"><bdi class="secno">1.1.4 </bdi>version 3.0.1<span class="formerLink" aria-label="§"></span></a></li></ol></li></ol></li><li class="tocline"><a class="tocxref" href="#revisionhistory"><bdi class="secno">A. </bdi>Revision History</a></li></ol></nav>

<section id="main-context" data-format="markdown"><h2 id="errata-for-open-badges-3-0-specification"><bdi class="secno">1. </bdi>Errata for Open Badges 3.0 Specification<a class="self-link" aria-label="§" href="#main-context"></a><a class="self-link" aria-label="§" href="#errata-for-open-badges-3-0-specification"></a></h2><section id="context-file-0"><h3 id="context-file"><bdi class="secno">1.1 </bdi>Context file<a class="self-link" aria-label="§" href="#context-file"></a><a class="self-link" aria-label="§" href="#context-file"></a></h3><p>The context file for Open Badges 3.0 follows a versioning as a result of <a href="https://github.com/1EdTech/openbadges-specification/issues/497">https://github.com/1EdTech/openbadges-specification/issues/497</a>. All changes to this file that may lead to invalid signatures and errors (breaking changes) must lead to a new version of the file.</p><section id="what-constitutes-a-breaking-change-0"><h4 id="what-constitutes-a-breaking-change"><bdi class="secno">1.1.1 </bdi>What constitutes a breaking change<a class="self-link" aria-label="§" href="#what-constitutes-a-breaking-change"></a><a class="self-link" aria-label="§" href="#what-constitutes-a-breaking-change"></a></h4><p>The policy used to determine what constitutes breaking changes to the specification, and therefore to the context file, can be summarized as:</p><ul>
<li>Adding new terms to the model/context <em>is not</em> a breaking change.</li>
Expand All @@ -650,12 +650,16 @@ <h2>IPR and Distribution Notice</h2>
<p>As a consumer of ClrCredentials, now when I verify a ClrCredential where the issuer had included an identifier for the user at this level, it will now show up, whereas previously it would not have appeared if any JSON-LD operation had been done on the data. No other change to software is necessary.</p>
</blockquote><p>According to this policy, this section recaps all the changes made to the context file which constitute a breaking change, and therefore, a new version of the file.</p><div class="note" role="note" id="issue-container-generatedID"><div role="heading" class="note-title marker" id="h-note" aria-level="5"><span>Note</span></div><div class="">
Previous versions of the context file will remain accessible, in order to keep backwards compatibility with existing credentials. However, it's recommended to refer to the newest version of the file.
</div></div></section><section id="version-3-0-2-0"><h4 id="version-3-0-2"><bdi class="secno">1.1.2 </bdi>version 3.0.2<a class="self-link" aria-label="§" href="#version-3-0-2"></a><a class="self-link" aria-label="§" href="#version-3-0-2"></a></h4><ul>
</div></div></section><section id="version-3-0-3-0"><h4 id="version-3-0-3"><bdi class="secno">1.1.2 </bdi>version 3.0.3<a class="self-link" aria-label="§" href="#version-3-0-3"></a><a class="self-link" aria-label="§" href="#version-3-0-3"></a></h4><p>-<code>@id</code> of <code>image</code> in <code>Achievement</code> now points to <code>https://purl.imsglobal.org/spec/vc/ob/vocab.html#image</code>
-<code>@id</code> of <code>achievement</code> in <code>AchievementSubject</code> now points to <code>https://purl.imsglobal.org/spec/vc/ob/vocab.html#achievement</code>
-<code>@id</code> of <code>image</code> in <code>AchievementSubject</code> now points to <code>https://purl.imsglobal.org/spec/vc/ob/vocab.html#image</code>
-<code>@id</code> of <code>image</code> in <code>Profile</code> now points to <code>https://purl.imsglobal.org/spec/vc/ob/vocab.html#image</code>
-Removed <code>image</code> attribute</p></section><section id="version-3-0-2-0"><h4 id="version-3-0-2"><bdi class="secno">1.1.3 </bdi>version 3.0.2<a class="self-link" aria-label="§" href="#version-3-0-2"></a><a class="self-link" aria-label="§" href="#version-3-0-2"></a></h4><ul>
<li>Added <code>@protected</code> to all <code>@context</code>.</li>
<li>`"@type": "xsd:string"`` was removed where it appears. This is the default type, but in rare cases, processing systems handle an explicit declaration of this type differently from allowing the default. For VCs, it is considered more reliable to just allow the default to be applied.</li>
<li><code>id</code> and `type`` aliases are redeclared in every context. This avoids a narrow type of attack where somebody might place a context that redeclares these terms in between the top layer and a class-specific layer of a credential, changing the values of these terms within the class implementation.</li>
<li>Changed <code>@container</code> of <code>allowedValue</code> from <code>@set</code> to <code>@list</code>, as <code>allowedValue</code> is an ordered list.</li>
</ul><p>-<code>@id</code> of <code>image</code> now points to <code>https://purl.imsglobal.org/spec/vc/ob/vocab.html#Image</code>. This prevent a redefinition of the term, since its previous value was incorrectly equals to <code>Achievement.image</code>.</p></section><section id="version-3-0-1-0"><h4 id="version-3-0-1"><bdi class="secno">1.1.3 </bdi>version 3.0.1<a class="self-link" aria-label="§" href="#version-3-0-1"></a><a class="self-link" aria-label="§" href="#version-3-0-1"></a></h4><ul>
</ul><p>-<code>@id</code> of <code>image</code> now points to <code>https://purl.imsglobal.org/spec/vc/ob/vocab.html#Image</code>. This prevent a redefinition of the term, since its previous value was incorrectly equals to <code>Achievement.image</code>.</p></section><section id="version-3-0-1-0"><h4 id="version-3-0-1"><bdi class="secno">1.1.4 </bdi>version 3.0.1<a class="self-link" aria-label="§" href="#version-3-0-1"></a><a class="self-link" aria-label="§" href="#version-3-0-1"></a></h4><ul>
<li>Fixed <code>Achievement</code>'s <code>creator</code> IRI. Now points to <code>https://purl.imsglobal.org/spec/vc/ob/vocab.html#creator</code></li>
<li>Fixed <code>AchievementSubject</code>'s <code>achievement</code> IRI. Now points to <code>https://purl.imsglobal.org/spec/vc/ob/vocab.html#achievement-0</code></li>
<li>Fixed <code>Profiles</code>'s <code>phone</code> IRI. Now points to <code>https://purl.imsglobal.org/spec/vc/ob/vocab.html#phone</code></li>
Expand Down
Loading

0 comments on commit e273bce

Please sign in to comment.