Skip to main content

123 docs tagged with "reference"

View all tags

Access

REST endpoints tagged access: 14 operations.

Agent access

REST endpoints tagged agent-access: 22 operations.

API keys

REST endpoints tagged api-keys: 2 operations.

apiome auth

Inspect signed-in identity and accessible tenants.

apiome compat

Compare two OpenAPI revisions via independent oasdiff compatibility evidence.

apiome config

Show or change saved defaults in the user config file.

apiome contract

Compile and inspect executable contract suites for a version.

apiome convert

Convert a catalog item to OpenAPI; print the fidelity summary + warning.

apiome diff

Diff a local OpenAPI file against a published project version.

apiome export

Export a version to a target format via the emitter registry.

apiome formats

List the formats this deployment supports, in which directions and at which versions.

apiome help

Show concise usage, or --help for a subcommand.

apiome import

Import OpenAPI, Swagger, Arazzo, JSON Schema, and JSON Schema type documents into Apiome.

apiome lint

Score schema quality, list lint findings, and run the CI lint gate.

apiome mcp

MCP catalog endpoints and tenant governance.

apiome mock

Manage the hosted mock for published project versions.

apiome paths

List and inspect OpenAPI path templates for a project version.

apiome repos

List tenant Git repositories and inspect repository files.

apiome repository

Repository auto-refresh: trigger a refresh and inspect per-file state.

apiome verify

Run executable contract verification and emit CI artifacts.

Browse

REST endpoints tagged browse: 9 operations.

Catalog

REST endpoints tagged catalog: 10 operations.

Classes

REST endpoints tagged classes: 11 operations.

CLI reference

Every apiome command, option and exit code, generated from the CLI.

Comments

REST endpoints tagged comments: 10 operations.

Data

REST endpoints tagged data: 6 operations.

Deploy gate

REST endpoints tagged deploy-gate: 4 operations.

Domains

REST endpoints tagged domains: 6 operations.

Exit codes

What each apiome exit code means, for scripts and CI pipelines.

Export

REST endpoints tagged export: 11 operations.

Export jobs

REST endpoints tagged export-jobs: 6 operations.

Export mock

REST endpoints tagged export-mock: 6 operations.

Formats

REST endpoints tagged formats: 1 operation.

Governance

REST endpoints tagged governance: 25 operations.

Identity

REST endpoints tagged identity: 4 operations.

License

REST endpoints tagged license: 1 operation.

Lint

REST endpoints tagged lint: 11 operations.

MCP catalog

REST endpoints tagged mcp-catalog: 80 operations.

MCP keys

REST endpoints tagged mcp-keys: 7 operations.

MCP manifest

REST endpoints tagged mcp-manifest: 3 operations.

MCP policy

REST endpoints tagged mcp-policy: 3 operations.

MCP probe

REST endpoints tagged mcp-probe: 6 operations.

MCP prompts

The prompts the Apiome MCP server registers for `prompts/get`.

MCP reference

Tools, resources and prompts of the Apiome MCP server, from its registry.

MCP resources

The resources the Apiome MCP server registers for `resources/read`.

MCP tools

Every tool the Apiome MCP server exposes, with its arguments and results.

Mock server

REST endpoints tagged mock-server: 20 operations.

Onboarding

REST endpoints tagged onboarding: 5 operations.

Ops

REST endpoints tagged ops: 9 operations.

Paths

REST endpoints tagged paths: 33 operations.

Primitives

REST endpoints tagged primitives: 12 operations.

Project tags

REST endpoints tagged project-tags: 7 operations.

Projects

REST endpoints tagged projects: 11 operations.

Properties

REST endpoints tagged properties: 5 operations.

REST API reference

Every Apiome REST endpoint, generated from the OpenAPI document, one page per tag.

Reviews

REST endpoints tagged reviews: 7 operations.

SDK regen

REST endpoints tagged sdk-regen: 7 operations.

Slate

REST endpoints tagged slate: 17 operations.

Slate cache

REST endpoints tagged slate-cache: 10 operations.

Snippets

REST endpoints tagged snippets: 1 operation.

Spec import

REST endpoints tagged spec-import: 14 operations.

Spec sync

REST endpoints tagged spec-sync: 4 operations.

Style guides

REST endpoints tagged style-guides: 19 operations.

Supported formats

Every format Apiome imports and exports, generated from the registries.

Tenants

REST endpoints tagged tenants: 3 operations.

Types public

REST endpoints tagged types-public: 1 operation.

Untagged

REST endpoints that declare no tag: 8 operations.

Version tags

REST endpoints tagged version-tags: 4 operations.

Versions

REST endpoints tagged versions: 52 operations.

Webhooks

REST endpoints tagged webhooks: 6 operations.

Workspace

REST endpoints tagged workspace: 10 operations.