{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-intent-revealing-interface",
  "id": "intent-revealing-interface",
  "kind": "principle",
  "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": "Intent-Revealing Interface",
  "ref": "architecture:intent-revealing-interface",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-clear-semantics",
          "json": "https://banes-lab.com/json/records/lexicon/clear-semantics",
          "label": "Clear Semantics",
          "markdown": "https://banes-lab.com/records/lexicon/clear-semantics.md",
          "ref": "lexicon:clear-semantics"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-naming-consistency",
          "json": "https://banes-lab.com/json/records/lexicon/naming-consistency",
          "label": "Naming Consistency",
          "markdown": "https://banes-lab.com/records/lexicon/naming-consistency.md",
          "ref": "lexicon:naming-consistency"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-principle-of-least-surprise",
          "json": "https://banes-lab.com/json/records/architecture/principle-of-least-surprise",
          "label": "Principle of Least Surprise",
          "markdown": "https://banes-lab.com/records/architecture/principle-of-least-surprise.md",
          "ref": "architecture:principle-of-least-surprise"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-readability",
          "json": "https://banes-lab.com/json/records/lexicon/readability",
          "label": "Readability",
          "markdown": "https://banes-lab.com/records/lexicon/readability.md",
          "ref": "lexicon:readability"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-correct-usage",
          "json": "https://banes-lab.com/json/records/lexicon/correct-usage",
          "label": "Correct Usage",
          "markdown": "https://banes-lab.com/records/lexicon/correct-usage.md",
          "ref": "lexicon:correct-usage"
        }
      ],
      "relation": "enables"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-ambiguous-api",
          "json": "https://banes-lab.com/json/records/lexicon/ambiguous-api",
          "label": "Ambiguous API",
          "markdown": "https://banes-lab.com/records/lexicon/ambiguous-api.md",
          "ref": "lexicon:ambiguous-api"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-boolean-trap",
          "json": "https://banes-lab.com/json/records/architecture/boolean-trap",
          "label": "Boolean Trap",
          "markdown": "https://banes-lab.com/records/architecture/boolean-trap.md",
          "ref": "architecture:boolean-trap"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-concise-naming",
          "json": "https://banes-lab.com/json/records/lexicon/concise-naming",
          "label": "Concise Naming",
          "markdown": "https://banes-lab.com/records/lexicon/concise-naming.md",
          "ref": "lexicon:concise-naming"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-concise-naming-intent-revealing-interface",
          "json": "https://banes-lab.com/json/records/tension/concise-naming-intent-revealing-interface",
          "label": "Intent-Revealing Interface / Concise Naming",
          "markdown": "https://banes-lab.com/records/tension/concise-naming-intent-revealing-interface.md",
          "ref": "tension:concise-naming-intent-revealing-interface"
        }
      ],
      "relation": "tensions"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-ambiguous-api",
          "json": "https://banes-lab.com/json/records/lexicon/ambiguous-api",
          "label": "Ambiguous API",
          "markdown": "https://banes-lab.com/records/lexicon/ambiguous-api.md",
          "ref": "lexicon:ambiguous-api"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-boolean-trap",
          "json": "https://banes-lab.com/json/records/architecture/boolean-trap",
          "label": "Boolean Trap",
          "markdown": "https://banes-lab.com/records/architecture/boolean-trap.md",
          "ref": "architecture:boolean-trap"
        }
      ],
      "relation": "violated-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-name-the-concept",
          "json": "https://banes-lab.com/json/records/lexicon/name-the-concept",
          "label": "Name the Concept",
          "markdown": "https://banes-lab.com/records/lexicon/name-the-concept.md",
          "ref": "lexicon:name-the-concept"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-replace-boolean-with-enum",
          "json": "https://banes-lab.com/json/records/lexicon/replace-boolean-with-enum",
          "label": "Replace Boolean with Enum",
          "markdown": "https://banes-lab.com/records/lexicon/replace-boolean-with-enum.md",
          "ref": "lexicon:replace-boolean-with-enum"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-value-object",
          "json": "https://banes-lab.com/json/records/architecture/value-object",
          "label": "Value Object",
          "markdown": "https://banes-lab.com/records/architecture/value-object.md",
          "ref": "architecture:value-object"
        }
      ],
      "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-schema-canonical-data-semantics",
          "json": "https://banes-lab.com/json/records/architecture-category/schema-canonical-data-semantics",
          "label": "Schema / Canonical Data / Semantics",
          "markdown": "https://banes-lab.com/records/architecture-category/schema-canonical-data-semantics.md",
          "ref": "architecture-category:schema-canonical-data-semantics"
        }
      ],
      "relation": "category"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/anatomy/governance#file-governance-rules-eslint-closure-register-verb-reserved-eslint-rule-ts",
          "json": "https://banes-lab.com/json/source/governance/rules/eslint/closure-register-verb-reserved.eslint.rule.ts",
          "label": "rules/eslint/closure-register-verb-reserved.eslint.rule.ts",
          "markdown": "https://banes-lab.com/source/governance/rules/eslint/closure-register-verb-reserved.eslint.rule.ts.md",
          "ref": "anatomy:file-governance-rules-eslint-closure-register-verb-reserved-eslint-rule-ts"
        },
        {
          "href": "https://banes-lab.com/anatomy/governance#file-governance-rules-eslint-closure-registry-consumer-naming-eslint-rule-ts",
          "json": "https://banes-lab.com/json/source/governance/rules/eslint/closure-registry-consumer-naming.eslint.rule.ts",
          "label": "rules/eslint/closure-registry-consumer-naming.eslint.rule.ts",
          "markdown": "https://banes-lab.com/source/governance/rules/eslint/closure-registry-consumer-naming.eslint.rule.ts.md",
          "ref": "anatomy:file-governance-rules-eslint-closure-registry-consumer-naming-eslint-rule-ts"
        }
      ],
      "relation": "enforced-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-builder-pattern",
          "json": "https://banes-lab.com/json/records/architecture/builder-pattern",
          "label": "Builder Pattern",
          "markdown": "https://banes-lab.com/records/architecture/builder-pattern.md",
          "ref": "architecture:builder-pattern"
        }
      ],
      "relation": "reinforced-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-ubiquitous-language",
          "json": "https://banes-lab.com/json/records/architecture/ubiquitous-language",
          "label": "Ubiquitous Language",
          "markdown": "https://banes-lab.com/records/architecture/ubiquitous-language.md",
          "ref": "architecture:ubiquitous-language"
        }
      ],
      "relation": "enabled-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-anti-patterns",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-anti-patterns",
          "label": "Anti-patterns",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-anti-patterns.md",
          "ref": "chapter:/ontology#architecture-category-anti-patterns"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-creational-patterns",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-creational-patterns",
          "label": "Creational Patterns",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-creational-patterns.md",
          "ref": "chapter:/ontology#architecture-category-creational-patterns"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-schema-canonical-data-semantics",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-schema-canonical-data-semantics",
          "label": "Schema / Canonical Data / Semantics",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-schema-canonical-data-semantics.md",
          "ref": "chapter:/ontology#architecture-category-schema-canonical-data-semantics"
        },
        {
          "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-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/lexicon#lexicon-category-schema-canonical-data-semantics",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-schema-canonical-data-semantics",
          "label": "Schema / Canonical Data / Semantics",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-schema-canonical-data-semantics.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-schema-canonical-data-semantics"
        },
        {
          "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 operation's name and parameters state what it does for the caller.",
  "siblings": {
    "next": {
      "href": "https://banes-lab.com/ontology#architecture-principle-of-least-surprise",
      "json": "https://banes-lab.com/json/records/architecture/principle-of-least-surprise",
      "label": "Principle of Least Surprise",
      "markdown": "https://banes-lab.com/records/architecture/principle-of-least-surprise.md",
      "ref": "architecture:principle-of-least-surprise"
    },
    "previous": {
      "href": "https://banes-lab.com/ontology#architecture-ubiquitous-language",
      "json": "https://banes-lab.com/json/records/architecture/ubiquitous-language",
      "label": "Ubiquitous Language",
      "markdown": "https://banes-lab.com/records/architecture/ubiquitous-language.md",
      "ref": "architecture:ubiquitous-language"
    }
  },
  "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": [
    "Intent-Revealing API"
  ],
  "exemplar": {
    "after": "foo.activate();\nfoo.reserve({ quantity: 3, notify: true });",
    "before": "foo.update(\"s\", \"A\");\nfoo.apply(3, true);",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "API",
    "method",
    "class",
    "module"
  ],
  "severity": "recommended"
}