Comprehensive Learner Record Errata 2.0

Candidate Final Public
Spec Version 2.0

Candidate Final Public

Document Version:	1.0
Date Issued:	October 10, 2023
Status:	This document is for review and adoption by the 1EdTech membership.
This version:	https://www.imsglobal.org/spec/clr/v2p0/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 .

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

Abstract

1. Errata for Comprehensive Learner Record 2.0 Specification

1.1 Context file

The context file for Comprehensive Learner Record 2.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.1.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.1.2 version 2.0.1

Fixed obi's IRI inside ClrSubject's context. Now points to https://purl.imsglobal.org/spec/vc/ob/vocab.html#

A. Revision History

This section is non-normative.

Version No.	Document Version	Release Date	Comments
Version 2.0 IMS Candidate Final	1.0	October 10, 2023	Added changes in context.json file

You are here