A controlled vocabulary or term set that an API's data references — the shared dictionary of codes, enums, and concepts that gives fields consistent meaning.

Also known as: Controlled Vocabulary, Terminology, Term Set, Code System

Example

- type: Vocabulary
  url: https://developers.example.com/vocabulary

Standards

• Community (MIT, APIPatterns) API Anatomy — a shared vocabulary for the parts of an API
• W3C Recommendation SKOS — Simple Knowledge Organization System
• W3C Recommendation JSON-LD 1.1
• Schema.org schema.org

OpenAPI Expression

• components.schemas.{name}.enum (OpenAPI 3.x) — Where a controlled vocabulary usually surfaces in a description — as an inline enum with no pointer back to the term set that governs it.
• components.schemas.{name}.x-vocabulary (Vendor extension) — Used to name the authoritative vocabulary an enum is drawn from, so consumers can resolve terms rather than hard-code them.
• externalDocs (OpenAPI 3.x) — Can point at the published vocabulary backing the API's codes and terms.

Related Properties

• Json ld
• Json ld context
• Json schema
• Standards
• Data contract

Tags

• Vocabulary
• Terms
• Semantics

All Common Properties