Schema registry

OKF Graph

Graph generated for an OKF bundle

okf.json

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your okf.json and it validates in your browser — nothing is uploaded.

Validate a okf.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`version`required	`string`	Schema version of this OKF graph format.
`generated`	`object`	An actor and optional timestamp (generated.by / verified[].by). Actor convention: <producer>/<version>, human:<id>, process:<id>.
`generated.by`	`string`	Actor that performed the action.
`generated.at`	`string`	When the action occurred.
`timestamp`	`string`	UTC timestamp when the graph was generated. Same instant as generated.at.
`bundle`	`object`	Optional object containing custom properties passed via -p when generating the graph. Only present when such properties were provided.
`nav`	`object`	A node in the index-driven navigation tree. Directories are not concepts (reserved index.md).
`nav.kind`required	`string`	group/orphans are non-routeable grouping headers; dir and concept are navigable. one of: `"group", "dir", "concept", "orphans"`
`nav.id`	`string`	Concept id, or directory path relative to bundle root (empty string for root). Omitted for group and orphans.
`nav.label`	`string`	Display label (index link text, section heading, or derived title).
`nav.description`	`string`	Optional short description from index entry or concept frontmatter.
`nav.body`	`string`	Index markdown for kind=dir (authored after optional root frontmatter strip, or synthetic listing). Parallel to node.body.
`nav.synthetic`	`boolean`	True when body/children were synthesized because index.md was missing.
`nav.children`	`array`	Child nav nodes (groups, dirs, concepts, trailing orphans).
`nodes`required	`array`	List of concept nodes in the knowledge graph.
`edges`required	`array`	Directed edges representing links between concepts.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
64 properties, 72% carrying a description, max nesting depth 6.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`format`	JSON Schema Validation, draft 2020-12	§7 — Vocabularies for Semantic Content With "format"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`minimum`	JSON Schema Validation, draft 2020-12	§6.2.4 — "minimum"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"
`format: "date"`	RFC 3339	§5.6 — Internet Date/Time Format
`format: "date-time"`	RFC 3339	§5.6 — Internet Date/Time Format

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas