{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-self-describing-api",
  "id": "self-describing-api",
  "kind": "principle",
  "layer": {
    "href": "https://banes-lab.com/ontology/schema#layer-declarative-core",
    "json": "https://banes-lab.com/json/records/layer/declarative-core",
    "label": "Declarative Core",
    "markdown": "https://banes-lab.com/records/layer/declarative-core.md",
    "ref": "layer:declarative-core"
  },
  "name": "Self-Describing API",
  "ref": "architecture:self-describing-api",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-api-contract",
          "json": "https://banes-lab.com/json/records/architecture/api-contract",
          "label": "API Contract",
          "markdown": "https://banes-lab.com/records/architecture/api-contract.md",
          "ref": "architecture:api-contract"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-metadata",
          "json": "https://banes-lab.com/json/records/lexicon/metadata",
          "label": "Metadata",
          "markdown": "https://banes-lab.com/records/lexicon/metadata.md",
          "ref": "lexicon:metadata"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-discoverability",
          "json": "https://banes-lab.com/json/records/lexicon/discoverability",
          "label": "Discoverability",
          "markdown": "https://banes-lab.com/records/lexicon/discoverability.md",
          "ref": "lexicon:discoverability"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-interoperability",
          "json": "https://banes-lab.com/json/records/architecture/interoperability",
          "label": "Interoperability",
          "markdown": "https://banes-lab.com/records/architecture/interoperability.md",
          "ref": "architecture:interoperability"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-client-generation",
          "json": "https://banes-lab.com/json/records/lexicon/client-generation",
          "label": "Client Generation",
          "markdown": "https://banes-lab.com/records/lexicon/client-generation.md",
          "ref": "lexicon:client-generation"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-hateoas-style-navigation",
          "json": "https://banes-lab.com/json/records/lexicon/hateoas-style-navigation",
          "label": "HATEOAS-style Navigation",
          "markdown": "https://banes-lab.com/records/lexicon/hateoas-style-navigation.md",
          "ref": "lexicon:hateoas-style-navigation"
        }
      ],
      "relation": "enables"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-opaque-api",
          "json": "https://banes-lab.com/json/records/lexicon/opaque-api",
          "label": "Opaque API",
          "markdown": "https://banes-lab.com/records/lexicon/opaque-api.md",
          "ref": "lexicon:opaque-api"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-payload-verbosity",
          "json": "https://banes-lab.com/json/records/lexicon/payload-verbosity",
          "label": "Payload Verbosity",
          "markdown": "https://banes-lab.com/records/lexicon/payload-verbosity.md",
          "ref": "lexicon:payload-verbosity"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-payload-verbosity-self-describing-api",
          "json": "https://banes-lab.com/json/records/tension/payload-verbosity-self-describing-api",
          "label": "Self-Describing API / Payload Verbosity",
          "markdown": "https://banes-lab.com/records/tension/payload-verbosity-self-describing-api.md",
          "ref": "tension:payload-verbosity-self-describing-api"
        }
      ],
      "relation": "tensions"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-opaque-api",
          "json": "https://banes-lab.com/json/records/lexicon/opaque-api",
          "label": "Opaque API",
          "markdown": "https://banes-lab.com/records/lexicon/opaque-api.md",
          "ref": "lexicon:opaque-api"
        }
      ],
      "relation": "violated-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-define-contract",
          "json": "https://banes-lab.com/json/records/lexicon/define-contract",
          "label": "Define Contract",
          "markdown": "https://banes-lab.com/records/lexicon/define-contract.md",
          "ref": "lexicon:define-contract"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-declare-capability",
          "json": "https://banes-lab.com/json/records/lexicon/declare-capability",
          "label": "Declare Capability",
          "markdown": "https://banes-lab.com/records/lexicon/declare-capability.md",
          "ref": "lexicon:declare-capability"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-standard-error-contract",
          "json": "https://banes-lab.com/json/records/lexicon/standard-error-contract",
          "label": "Standard Error Contract",
          "markdown": "https://banes-lab.com/records/lexicon/standard-error-contract.md",
          "ref": "lexicon:standard-error-contract"
        }
      ],
      "relation": "refactored-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#vocabulary-severity-recommended",
          "json": "https://banes-lab.com/json/records/vocabulary/severity-recommended",
          "label": "recommended",
          "markdown": "https://banes-lab.com/records/vocabulary/severity-recommended.md",
          "ref": "vocabulary:severity-recommended"
        }
      ],
      "relation": "severity"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-metadata-self-description-declarative-systems",
          "json": "https://banes-lab.com/json/records/architecture-category/metadata-self-description-declarative-systems",
          "label": "Metadata / Self-Description / Declarative Systems",
          "markdown": "https://banes-lab.com/records/architecture-category/metadata-self-description-declarative-systems.md",
          "ref": "architecture-category:metadata-self-description-declarative-systems"
        }
      ],
      "relation": "category"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/anatomy/build-scripts#file-build-scripts-runtime-entrypoints-validation-entrypoint-ts",
          "json": "https://banes-lab.com/json/source/build-scripts/runtime/entrypoints/validation.entrypoint.ts",
          "label": "runtime/entrypoints/validation.entrypoint.ts",
          "markdown": "https://banes-lab.com/source/build-scripts/runtime/entrypoints/validation.entrypoint.ts.md",
          "ref": "anatomy:file-build-scripts-runtime-entrypoints-validation-entrypoint-ts"
        }
      ],
      "relation": "enforced-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-contracts-interfaces-compatibility",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-contracts-interfaces-compatibility",
          "label": "Contracts / Interfaces / Compatibility",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-contracts-interfaces-compatibility.md",
          "ref": "chapter:/ontology#architecture-category-contracts-interfaces-compatibility"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-contracts-interfaces-compatibility",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-contracts-interfaces-compatibility",
          "label": "Contracts / Interfaces / Compatibility",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-contracts-interfaces-compatibility.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-contracts-interfaces-compatibility"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-core-vocabulary",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-core-vocabulary",
          "label": "Core Vocabulary",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-core-vocabulary.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-core-vocabulary"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-metadata-self-description-declarative-systems",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-metadata-self-description-declarative-systems",
          "label": "Metadata / Self-Description / Declarative Systems",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-metadata-self-description-declarative-systems.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-metadata-self-description-declarative-systems"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-quality-attributes",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-quality-attributes",
          "label": "Quality Attributes",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-quality-attributes.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-quality-attributes"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-vocabulary-severity",
          "json": "https://banes-lab.com/json/ontology/schema/the-vocabulary-severity",
          "label": "Severity levels",
          "markdown": "https://banes-lab.com/ontology/schema/the-vocabulary-severity.md",
          "ref": "chapter:/ontology/schema#the-vocabulary-severity"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-resolutions",
          "json": "https://banes-lab.com/json/ontology/schema/the-resolutions",
          "label": "The resolutions",
          "markdown": "https://banes-lab.com/ontology/schema/the-resolutions.md",
          "ref": "chapter:/ontology/schema#the-resolutions"
        }
      ],
      "relation": "linked-from"
    }
  ],
  "summary": "A design rule that an API publishes machine-readable descriptions of its operations, payloads and errors.",
  "siblings": {
    "next": {
      "href": "https://banes-lab.com/ontology#architecture-self-describing-structures",
      "json": "https://banes-lab.com/json/records/architecture/self-describing-structures",
      "label": "Self-Describing Structures",
      "markdown": "https://banes-lab.com/records/architecture/self-describing-structures.md",
      "ref": "architecture:self-describing-structures"
    },
    "previous": {
      "href": "https://banes-lab.com/ontology#architecture-self-describing-architecture",
      "json": "https://banes-lab.com/json/records/architecture/self-describing-architecture",
      "label": "Self-Describing Architecture",
      "markdown": "https://banes-lab.com/records/architecture/self-describing-architecture.md",
      "ref": "architecture:self-describing-architecture"
    }
  },
  "up": {
    "href": null,
    "json": "https://banes-lab.com/json/api/records/architecture",
    "label": "Architecture principles",
    "markdown": "https://banes-lab.com/api/records/architecture.md",
    "ref": "api:records/architecture"
  },
  "aliases": [],
  "exemplar": {
    "after": "const createFooApi = defineEndpoint({\n  method: \"POST\",\n  path: \"/foos\",\n  request: CreateFooSchema,\n  response: FooCreatedSchema,\n  errors: FooErrorSchema,\n});",
    "before": "app.post(\"/foo\", createFoo);",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "API",
    "integration"
  ],
  "severity": "recommended"
}