{
  "markdown": "# spec-objects-architecture\n\n> Filament Module: tier-2 architecture ObjectTypes (api_endpoint, data_schema, queue, action, ui_component, rate_limit, interface, external_contract, extension_point, binary_format)\n\nThis is an Agent-IX Filament module loaded by [`quire-cli`](https://github.com/agent-ix/quire-cli) and [`quoin`](https://github.com/agent-ix/quoin). It provides tier-2 embedded `object_types` — a `manifest.yaml` plus per-kind authoring `skeletons/` used to author and validate Markdown spec artifacts.\n\n## Installing quire-cli\n\n`@agent-ix` packages are published to public npm. Install the CLI globally:\n\n```bash\nnpm install -g @agent-ix/quire-cli\n```\n\nSee https://github.com/agent-ix/quire-cli#install for details.\n\n## Install this module via npm\n\nThis module is also published as a config-only npm package: `@agent-ix/spec-objects-architecture`.\nThe package root **is** the Filament module (`manifest.yaml` + schemas/skeletons),\nso it works directly as a `--module` target or via quoin's `package:` source.\n\n```bash\nnpm install @agent-ix/spec-objects-architecture\n```\n\n```bash\n# quoin — resolve the module from npm by name\nquoin plugin install package:@agent-ix/spec-objects-architecture\n\n# or point any tool at the installed package root\nquire validate spec/**/*.md --module node_modules/@agent-ix/spec-objects-architecture\n```\n\n## Object types provided\n\n| Object | `type:` | Description |\n|:-------|:--------|:------------|\n| API endpoint | `api_endpoint` | An HTTP endpoint surface: a required `Endpoint` section describing what it does plus its method/path routes, and an optional `2. API Contract` section for request/response/auth detail. |\n| Data schema | `data_schema` | A JSON-shaped record defined by a required `Schema` section holding a JSON Schema (draft 2020-12) code block. |\n| Queue | `queue` | A message queue defined by a required `Message Format` section holding an example JSON message payload (or its schema). |\n| Action | `action` | A discrete action/task defined by a required `Inputs` section listing every input it consumes, with type and source. |\n| UI component | `ui_component` | A frontend component defined by a required `Props` section enumerating every prop with name, type, and behavior. |\n| Rate limit | `rate_limit` | A throttling policy defined by a required `Thresholds` section listing the concrete limits, windows, and the response when a limit is exceeded. |\n| Interface | `interface` | A language-neutral operations contract *within* the system, defined by a required `Contract` section holding a YAML code block (name, types, operations, invariants). |\n| External contract | `external_contract` | A contract with a system *outside* this one, with a required `Contract` section plus optional `Endpoints` and `Behavior` sections for the consumed/exposed surface and interaction semantics. |\n| Extension point | `extension_point` | First-class pluggability: a required `Contract` section naming the interface it exposes, plus optional `Registration` and `Stability` sections for discovery and compatibility guarantees. |\n| Binary format | `binary_format` | A persisted binary layout defined by a required `Layout` section holding a YAML code block of record types with per-field name/offset/size/type/endianness. |\n\n## How this module is used\n\n### With quoin (recommended)\n\nInstall this module as a plugin, then author and review spec artifacts:\n\n```bash\nquoin plugin install path:../spec-objects-architecture\nquoin catalog list\nquoin write . --types api_endpoint,data_schema\nquoin review\n```\n\nSee [quoin](https://github.com/agent-ix/quoin) for details.\n\n### With quire-cli directly\n\nPoint `quire` at this module's package directory to fetch a skeleton, validate documents, or extract a document's structured body:\n\n```bash\nquire schema api_endpoint --module ./spec_objects_architecture\nquire validate spec/**/*.md --module ./spec_objects_architecture\nquire extract spec/upload-artifact.md --module ./spec_objects_architecture\n```\n\nSee [quire-cli#usage-instructions](https://github.com/agent-ix/quire-cli#usage-instructions) for details.\n\n## Development\n\n- **Library name:** `spec_objects_architecture` (flat layout, package at repo root)\n- **Language / tooling:** Python 3.13+, [Poetry](https://python-poetry.org/), GitHub Actions CI\n- **Versioning:** dynamic, Git-tag-based\n- **Publishing:** Google Artifact Registry (PyPI-compatible) via `twine upload -r internal-pypi` in CI on `tag v*.*.*`\n\nCommon Makefile targets:\n\n| Target | Description |\n|:-------|:------------|\n| `install` | Install dependencies in Poetry venv |\n| `test` | Run tests (pytest) |\n| `lint` | Run linting (Ruff + Black check) |\n| `format` | Auto-format code (Ruff + Black) |\n| `build` | Build wheel and sdist under `dist/` |\n| `update-lock` | Update `poetry.lock` |\n| `update-packages` | Update all dependencies |\n| `add-package p=<name>` | Add a runtime dependency |\n| `add-dev-package p=<name>` | Add a dev dependency |\n| `use-local p=<name>` | Switch a dep to local `pypi.ix` |\n| `use-upstream p=<name>` | Switch a dep back to upstream |\n| `local-publish` | Build and publish to local PyPI (`pypi.ix`) |\n",
  "bytes": 5134,
  "sha": "9629a1c079aaa87713183f2115a711d96cdd10524a509a1ce4ceccc021dff738",
  "repo_slug": "agent-ix/spec-objects-architecture",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/okf_agent_ix_spec_objects_architecture_spec__bb37412e/readme"
}