We need a lightweight way to make badge classes discoverable on a domain, so that we can build discovery tools like the Badge Codex.
Domains can advertise their badge classes by publishing a document at /.well-known/openbadge-classes.json
. This JSON-formatted document must be served with the content type application/json
.
The document simply contains an array of domain-relative URLs representing BadgeClass JSON instances, like so:
[
"/badge-classes/a-lister.json",
"/badge-classes/code-whisperer.json"
]
Clients accessing the document should check for a Link header. If it exists, the client may need to iterate through all pages via the next
value for rel
to obtain a full list of badge classes advertised by the domain.
This proposal was inspired by the following specifications:
Brian's servicefederation.md gist also has some good discussion on discoverability standards.