OKF Validator
Check required guide-profile fields before publishing.
Open pageTemplate detail
API OKF template
Use this copyable API OKF template when a single concept needs stable frontmatter, readable Markdown, and links to related knowledge.
Who this template fits
- API teams documenting endpoint context around OpenAPI contracts.
- Teams that need portable Markdown files with searchable frontmatter.
- Editors who can review source links and update timestamps.
Who should not use it
- Teams looking for schema validation or client generation.
- Teams that need a database-backed workflow before they have stable source material.
- Anyone trying to publish private keys, secrets, or confidential customer data.
Copyable template
---
type: API Endpoint
title: API OKF
description: Starter api endpoint file with owner notes, links, and review fields.
resource: https://openknowledgeformat.online/templates/api-okf-template/
tags: [okf, api, template]
timestamp: 2026-06-21T00:00:00Z
---
# Purpose
Explain the stable facts, boundaries, owner notes, and related links for this concept.
# Links
- Validator: https://openknowledgeformat.online/okf-validator/
- Examples: https://openknowledgeformat.online/okf-examples/Field explanations
Field
How to fill it
type
Use a precise label such as
API Endpoint.title
Use a human-readable concept name, not only a file name.
description
Write one sentence that explains the concept and boundary.
resource
Point to a canonical URL, stable URN, or source asset.
tags
Use short labels for routing and filtering.
Correct example
---
type: API Endpoint
title: API OKF
description: Starter api endpoint file with owner notes, links, and review fields.
resource: https://openknowledgeformat.online/templates/api-okf-template/
tags: [okf, api, template]
timestamp: 2026-06-21T00:00:00Z
---
# Purpose
Explain the stable facts, boundaries, owner notes, and related links for this concept.
# Links
- Validator: https://openknowledgeformat.online/okf-validator/
- Examples: https://openknowledgeformat.online/okf-examples/Incorrect example
---
title: API OKF template
---
# Notes
This file is missing type, description, tags, resource, and a clear concept boundary.Validate with OKF Validator
- Copy the template.
- Replace title, description, resource, tags, and body content.
- Paste the file into the OKF Validator.
- Fix errors first, then review warnings and source accuracy.
FAQ
Common questions
Can I publish the template unchanged?
No. Replace sample resource links, tags, and body content first.
Does validation prove the content is correct?
No. Validation checks structure; humans still need to review facts and sources.
Related pages
Check this template
Paste your edited file into the validator before adding it to a bundle.
Validate OKF file