Skip to content

transcript.md

Latest commit

 

History

History
39 lines (30 loc) · 1.22 KB

transcript.md

File metadata and controls

39 lines (30 loc) · 1.22 KB

Transcript

A transcript is a collection of transcript entries. It is optional and acts as a convenience container for portability.

Requirements

  • Includes 1 or more transcript entries.
  • There is no required format.
  • There is no additional signing.

Recommendations

  • A Simple JSON file with array of transcript entries.
  • A Simple YAML file with array of transcript entries.
  • A PDF document with embedded JSON/YAML file.

Example

# yaml-language-server: $schema=https://raw.githubusercontent.com/openproficiency/model/refs/heads/main/schemas/transcript.schema.json

- user-email: first.last@example.com
  topic: addition
  topic-list: https://example.com/topic-lists/0.1.0/math.yml
  score: competent
  issued-at: 2026-01-01T01:01:01Z
  valid-until: 2028-01-01T01:01:01Z
  issued-by: example.com
  certificate: -----BEGIN CERTIFICATE-----ABC123DEF456-----END CERTIFICATE-----

- user-email: first.last@example.com
  topic: subtraction
  topic-list: https://example.com/topic-lists/0.1.0/math.yml
  score: competent
  issued-at: 2026-01-01T01:01:01Z
  valid-until: 2028-01-01T01:01:01Z
  issued-by: example.com
  certificate: -----BEGIN CERTIFICATE-----ABC123DEF456-----END CERTIFICATE-----