Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ob_v2p0 from develop #300

Merged
merged 2 commits into from
May 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions ob_v2p0/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,7 @@ Here, an endorser claims to have verified the email address published in the Pro
"type": "Endorsement",
"id": "https://example.org/endorsement-123.json",
"issuer": "https://example.org/issuer-5.json",
"issuedOn": "2016-12-31T23:59:59+00:00",
"claim": {
"id": "https://example.org/organization.json",
"email": "[email protected]",
Expand All @@ -574,6 +575,7 @@ Another prominent use of Endorsements is to provide a comment expressing approva
"type": "Endorsement",
"id": "https://example.org/endorsement-124.json",
"issuer": "https://example.org/issuer-5.json",
"issuedOn": "2016-12-31T23:59:59+00:00",
"claim": {
"id": "https://example.org/robotics-badge.json",
"endorsementComment": "This badge and its associated learning material are great examples of beginning robotics education."
Expand All @@ -591,6 +593,7 @@ The same method could be used to support a single recipient's achievement throug
"type": "Endorsement",
"id": "https://example.org/endorsement-125.json",
"issuer": "https://example.org/issuer-5.json",
"issuedOn": "2016-12-31T23:59:59+00:00",
"claim": {
"id": "https://example.org/beths-robotics-badge.json",
"endorsementComment": "This student built a great robot.",
Expand All @@ -601,3 +604,15 @@ The same method could be used to support a single recipient's achievement throug
}
}
{% endhighlight %}

An `Endorsement` may also be revoked by the Issuer. Here is an example of
{% highlight json %}
{
"@context": "https://w3id.org/openbadges/v2",
"type": "Endorsement",
"id": "https://example.org/endorsement-125.json",
"issuer": "https://example.org/issuer-5.json",
"revoked": true,
"revocationReason": "Issued in error."
}
{% endhighlight %}
2 changes: 1 addition & 1 deletion ob_v2p0/extensions/endorsement/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Endorsement extension is deprecated since v2.0, with the addition of [Endors
### <a id="Endorsement"></a>Endorsement
_Author: [Nate Otto](http://ottonomy.net)_

Any organization that is set up to issue badges may provide endorsements of other issuers' badge objects (Assertion, Badge Class or Issuer). For example, a school district may issue an endorsement to indicate approval of a specific Badge Class corresponding to professional development credits acceptable by the district. See the Badge Alliance Endorsement Working Group [framework paper](https://docs.google.com/document/d/1VVf19d72KmGMh1ywrLe7HCKEOqGSI0WjvwfGN_8Q2M4/edit) for background.
Any organization that is set up to issue badges may provide endorsements of other issuers' badge objects (Assertion, Badge Class or Issuer). For example, a school district may issue an endorsement to indicate approval of a specific Badge Class corresponding to professional development credits acceptable by the district.

Endorsement of a Badge Class serves to publicly acknowledge the value of a badge as *designed, assessed, and issued by a badge issuer*. Endorsements of an Issuer are presumed to apply to all Badge Classes and Assertions created by that Issuer. See the [context](./endorsement/context.json) and [schema](./endorsement/schema.json) for endorsement.

Expand Down
2 changes: 1 addition & 1 deletion ob_v2p0/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Join the [Badge Alliance Standard Working Group](https://groups.google.com/forum

Official proposals are made by contributing a pull request on GitHub. Pull requests let you tell others about changes you've pushed to a GitHub repository.

Go to the [Open Badges spec repository](https://github.com/openbadges/openbadges-specification), then fork the code, modify it, and save it back to your forked repository. Submit a pull request to the origin repository master branch to initiate a review of the proposed changes.
Go to the [Open Badges spec repository](https://github.com/openbadges/openbadges-specification), then fork the code, modify it, and save it back to your forked repository. Submit a pull request to the origin repository main branch to initiate a review of the proposed changes.

Once a pull request is sent, interested parties can review the set of changes and discuss potential modifications before deciding whether and how to integrate them. The Standard Working Group makes a call for consensus, and if successful, merges the proposed changes.

Expand Down
9 changes: 6 additions & 3 deletions ob_v2p0/history/2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,14 @@ Open Badges 2.0 contains a minimal set of breaking changes. For issuers, it will

Since the 2.0 specification was published on January 1st 2017, a few errors and typos have been discovered and corrected in-place on [openbadgespec.org](http://www.openbadgespec.org).

For full transparency, these edits can be reviewed at the [GitHub Open Badges master branch commit history page](https://github.com/openbadges/openbadges-specification/commits/master). The first in-place edit was committed on January 10th of 2017.
For full transparency, these edits can be reviewed at the [GitHub Open Badges main branch commit history page](https://github.com/openbadges/openbadges-specification/commits/master). The first in-place edit was committed on January 10th of 2017.

Additional errata:
* April 9th of 2020 the work group decided to require usage of PNG or SVG for all images under this specification.
* In October 2020, the work group indicated that an error with the `targetFramework` term in the [V2 Context](https://w3id.org/openbadges/v2) should be corrected in place. This term previously referenced a non-existent `schema:targetFramework` term when the appropriate term in schema.org's vocabulary is [educationalFramework](http://schema.org/educationalFramework). An impact analysis was performed resulting in a conclusion that there would be very little effect on implementations in any role.
* February 11th of 2021 the work group updated the Endorsement examples to include the required issuedOn property for completeness.
* February 11th of 2021 the work group decided to transition to a "main" branch as part of a [larger initiative](https://github.com/github/renaming).
* In February 2021, the description of `validatesType` was improved to indicate how exact matching is handled.
* March 11th of 2021 the work group updated the Endorsement documentation to include revocation funtionality that had already been possible.

Please note that the IMS Global version of the Open Badges specification, which contains additional formatting and layout changes, are not reflected in the master repository commit history.


Loading