{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-api-contract",
  "id": "api-contract",
  "kind": "constraint",
  "layer": {
    "href": "https://banes-lab.com/ontology/schema#layer-contracts-core",
    "json": "https://banes-lab.com/json/records/layer/contracts-core",
    "label": "Contracts Core",
    "markdown": "https://banes-lab.com/records/layer/contracts-core.md",
    "ref": "layer:contracts-core"
  },
  "name": "API Contract",
  "ref": "architecture:api-contract",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-schema",
          "json": "https://banes-lab.com/json/records/lexicon/schema",
          "label": "Schema",
          "markdown": "https://banes-lab.com/records/lexicon/schema.md",
          "ref": "lexicon:schema"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-versioning",
          "json": "https://banes-lab.com/json/records/architecture/versioning",
          "label": "Versioning",
          "markdown": "https://banes-lab.com/records/architecture/versioning.md",
          "ref": "architecture:versioning"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-stable-interfaces",
          "json": "https://banes-lab.com/json/records/architecture/stable-interfaces",
          "label": "Stable Interfaces",
          "markdown": "https://banes-lab.com/records/architecture/stable-interfaces.md",
          "ref": "architecture:stable-interfaces"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "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"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-predictability",
          "json": "https://banes-lab.com/json/records/architecture/predictability",
          "label": "Predictability",
          "markdown": "https://banes-lab.com/records/architecture/predictability.md",
          "ref": "architecture:predictability"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-client-compatibility",
          "json": "https://banes-lab.com/json/records/lexicon/client-compatibility",
          "label": "Client Compatibility",
          "markdown": "https://banes-lab.com/records/lexicon/client-compatibility.md",
          "ref": "lexicon:client-compatibility"
        }
      ],
      "relation": "enables"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-breaking-api-change",
          "json": "https://banes-lab.com/json/records/lexicon/breaking-api-change",
          "label": "Breaking API Change",
          "markdown": "https://banes-lab.com/records/lexicon/breaking-api-change.md",
          "ref": "lexicon:breaking-api-change"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-evolution",
          "json": "https://banes-lab.com/json/records/lexicon/evolution",
          "label": "Evolution",
          "markdown": "https://banes-lab.com/records/lexicon/evolution.md",
          "ref": "lexicon:evolution"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-api-contract-evolution",
          "json": "https://banes-lab.com/json/records/tension/api-contract-evolution",
          "label": "API Contract / Evolution",
          "markdown": "https://banes-lab.com/records/tension/api-contract-evolution.md",
          "ref": "tension:api-contract-evolution"
        }
      ],
      "relation": "tensions"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-ad-hoc-endpoints",
          "json": "https://banes-lab.com/json/records/lexicon/ad-hoc-endpoints",
          "label": "Ad-Hoc Endpoints",
          "markdown": "https://banes-lab.com/records/lexicon/ad-hoc-endpoints.md",
          "ref": "lexicon:ad-hoc-endpoints"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-inconsistent-error-model",
          "json": "https://banes-lab.com/json/records/architecture/inconsistent-error-model",
          "label": "Inconsistent Error Model",
          "markdown": "https://banes-lab.com/records/architecture/inconsistent-error-model.md",
          "ref": "architecture:inconsistent-error-model"
        }
      ],
      "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-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"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-versioning",
          "json": "https://banes-lab.com/json/records/architecture/versioning",
          "label": "Versioning",
          "markdown": "https://banes-lab.com/records/architecture/versioning.md",
          "ref": "architecture:versioning"
        }
      ],
      "relation": "refactored-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#vocabulary-severity-mandatory",
          "json": "https://banes-lab.com/json/records/vocabulary/severity-mandatory",
          "label": "mandatory",
          "markdown": "https://banes-lab.com/records/vocabulary/severity-mandatory.md",
          "ref": "vocabulary:severity-mandatory"
        }
      ],
      "relation": "severity"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-contracts-interfaces-compatibility",
          "json": "https://banes-lab.com/json/records/architecture-category/contracts-interfaces-compatibility",
          "label": "Contracts / Interfaces / Compatibility",
          "markdown": "https://banes-lab.com/records/architecture-category/contracts-interfaces-compatibility.md",
          "ref": "architecture-category:contracts-interfaces-compatibility"
        }
      ],
      "relation": "category"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-service-contract",
          "json": "https://banes-lab.com/json/records/architecture/service-contract",
          "label": "Service Contract",
          "markdown": "https://banes-lab.com/records/architecture/service-contract.md",
          "ref": "architecture:service-contract"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-self-describing-api",
          "json": "https://banes-lab.com/json/records/architecture/self-describing-api",
          "label": "Self-Describing API",
          "markdown": "https://banes-lab.com/records/architecture/self-describing-api.md",
          "ref": "architecture:self-describing-api"
        }
      ],
      "relation": "required-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#architecture-category-correctness-determinism-verification",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-correctness-determinism-verification",
          "label": "Correctness / Determinism / Verification",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-correctness-determinism-verification.md",
          "ref": "chapter:/ontology#architecture-category-correctness-determinism-verification"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-metadata-self-description-declarative-systems",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-metadata-self-description-declarative-systems",
          "label": "Metadata / Self-Description / Declarative Systems",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-metadata-self-description-declarative-systems.md",
          "ref": "chapter:/ontology#architecture-category-metadata-self-description-declarative-systems"
        },
        {
          "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/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 rule or precondition that each endpoint declares its request, response and error shapes in a versioned schema.",
  "siblings": {
    "next": {
      "href": "https://banes-lab.com/ontology#architecture-service-contract",
      "json": "https://banes-lab.com/json/records/architecture/service-contract",
      "label": "Service Contract",
      "markdown": "https://banes-lab.com/records/architecture/service-contract.md",
      "ref": "architecture:service-contract"
    },
    "previous": {
      "href": "https://banes-lab.com/ontology#architecture-contract-first-design",
      "json": "https://banes-lab.com/json/records/architecture/contract-first-design",
      "label": "Contract-First Design",
      "markdown": "https://banes-lab.com/records/architecture/contract-first-design.md",
      "ref": "architecture:contract-first-design"
    }
  },
  "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 getFooApi = endpoint({\n  method: \"GET\",\n  path: \"/v1/foo/{id}\",\n  request: FooIdSchema,\n  response: FooResponseSchema,\n  errors: [\"FOO_NOT_FOUND\"] as const,\n});",
    "before": "app.get(\"/foo/:id\", async request => fooStore.find(request.params.id));",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "API",
    "service boundary"
  ],
  "severity": "mandatory"
}