Open Badges Errata 3.0

Open Badges Errata

Final Release
Spec Version 3.0
Final Release
Document Version: 1.1
Date Issued: July 17, 2024
Status: This document is made available for adoption by the public community at large.
This version: https://www.imsglobal.org/spec/ob/v3p0/errata/

IPR and Distribution Notice

Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.

1EdTech takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on 1EdTech's procedures with respect to rights in 1EdTech specifications can be found at the 1EdTech Intellectual Property Rights webpage: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf .

Use of this specification to develop products or services is governed by the license with 1EdTech found on the 1EdTech website: http://www.imsglobal.org/speclicense.html.

Permission is granted to all parties to use excerpts from this document as needed in producing requests for proposals.

The limited permissions granted above are perpetual and will not be revoked by 1EdTech or its successors or assigns.

THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION.

Public contributions, comments and questions can be posted here: http://www.imsglobal.org/forums/ims-glc-public-forums-and-resources .

© 2024 1EdTech™ Consortium, Inc. All Rights Reserved.

Trademark information: http://www.imsglobal.org/copyright.html

Abstract

1. Errata for Open Badges 3.0 Specification

1.1 Data Model

1.2 Typography

  • The description of the field type in the entity GeoCoordinates should be MUST be the IRI 'GeoCoordinates'..

  • The description of the field type in the entity IdentifierEntry should be MUST be the IRI 'IdentifierEntry'..

  • Appearances of JsonSchemaValidator2019 in description fields inside JSON Schemas should be 1EdTechJsonSchemaValidator2019.

  • Description column for the property termsOfUse in AchievementCredential should be:

The value of the termsOfUse property tells the verifier what actions it is required to perform (an obligation), not allowed to perform (a prohibition), or allowed to perform (a permission) if it is to accept the verifiable credential.

The value of the termsOfUse property tells the verifier what actions it is required to perform (an obligation), not allowed to perform (a prohibition), or allowed to perform (a permission) if it is to accept the verifiable credential.

The value of the termsOfUse property tells the verifier what actions it is required to perform (an obligation), not allowed to perform (a prohibition), or allowed to perform (a permission) if it is to accept the verifiable credential.

The value of the termsOfUse property tells the verifier what actions it is required to perform (an obligation), not allowed to perform (a prohibition), or allowed to perform (a permission) if it is to accept the verifiable credential.

The value of the termsOfUse property tells the verifier what actions it is required to perform (an obligation), not allowed to perform (a prohibition), or allowed to perform (a permission) if it is to accept the verifiable credential.

The value of the termsOfUse property tells the verifier what actions it is required to perform (an obligation), not allowed to perform (a prohibition), or allowed to perform (a permission) if it is to accept the verifiable credential.

1.3 Context file

The context file for Open Badges 3.0 follows a versioning as a result of https://github.com/1EdTech/openbadges-specification/issues/497. All changes to this file that may lead to invalid signatures and errors (breaking changes) must lead to a new version of the file.

1.3.1 What constitutes a breaking change

The policy used to determine what constitutes breaking changes to the specification, and therefore to the context file, can be summarized as:

  • Adding new terms to the model/context is not a breaking change.
  • Changing term mappings or removing terms is a breaking change.

This policy implies that a downstream consumer must be willing to be forgiving on the data they receive: they must be willing/capable of ignoring terms they don't currently understand.

An example for this could be the change "add the term 'identifier' to the CLR context where it may appear in nodes of type 'ClrSubject'". Let's look at how an issuer and a verifier of a ClrCredential might need to understand or react to this change:

As an issuer of ClrCredentials, if you previously included identifier at this level, it had been dropped upon any JSON-LD processing operation. No change is needed to your system, but now the term will not be dropped by consumers (or by your cryptographic signing library) anymore. Bug fixed.

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.

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.

Note
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.

1.3.2 version 3.0.3

  • @id of image in Achievement now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#image
  • @id of achievement in AchievementSubject now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#achievement
  • @id of image in AchievementSubject now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#image
  • @id of image in Profile now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#image

1.3.3 version 3.0.2

  • Added @protected to all @context.
  • `"@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.
  • id 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.
  • Changed @container of allowedValue from @set to @list, as allowedValue is an ordered list.

-@id of image now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#Image. This prevent a redefinition of the term, since its previous value was incorrectly equals to Achievement.image.

1.3.4 version 3.0.1

  • Fixed Achievement's creator IRI. Now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#creator
  • Fixed AchievementSubject's achievement IRI. Now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#achievement-0
  • Fixed Profiles's phone IRI. Now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#phone
  • Added image attribute to Achievement.
  • Removed @type from alignment. This fixes a compaction error.
  • Removed @type from otherIdentifier. This fixes a compaction error.
  • Removed @type from Achievement's resultDescription. This fixes a compaction error.
  • Removed @type from AchievementSubject's identifier. This fixes a compaction error.
  • Added image attribute to AchievementSubject.
  • Removed @type from AchievementSubject's result. This fixes a compaction error.
  • Fixed @type from AchievementSubject's source. This fixes a compaction error.
  • Removed @type from ResultDescription's rubricCriterionLevel. This fixes a compaction error.
  • Removed @type from endorsement. This fixes a compaction error.
  • Added image attribute to Profile.
  • Fixed Profile's address IRI. Now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#address
  • Removed @type from Achievement's related. This fixes a compaction error.
  • Added type attribute to Profiles address. This fixes a compaction error.
  • Fixed type attribute of Profiles parentOrg.
  • Fixed type attribute of Image.
  • Fixed @id attribute of Alignment. Now points to https://schema.org/AlignmentObject.
  • Added awardedDate attribute to VerifiableCredential.

A. Revision History

This section is non-normative.

Version No. Document Version Release Date Comments
Version 3.0 Candidate Final 1.0 March 6, 2023 Added changes in context.json file
Version 3.0 Final 1.0 June 17, 2024 Added typography errors
Version 3.0 Final 1.1 July 26, 2024 Added typography errors

1EdTech™ Consortium, Inc. ("1EdTech") is publishing the information contained in this document ("Specification") for purposes of scientific, experimental, and scholarly collaboration only.

1EdTech makes no warranty or representation regarding the accuracy or completeness of the Specification.

This material is provided on an "As Is" and "As Available" basis.

The Specification is at all times subject to change and revision without notice.

It is your sole responsibility to evaluate the usefulness, accuracy, and completeness of the Specification as it relates to you.

1EdTech would appreciate receiving your comments and suggestions.

Please contact 1EdTech through our website at www.1edtech.org.

Please refer to Document Name: Open Badges Errata 3.0

Date: July 17, 2024