api-reference

Render canonical API schema and examples

Install

docsloth component add @docsloth/api-reference@1.0.0

Live package: sha256:f160e0216f9fe7a01fe1e831d6ed8eeed9f996726ef6e6e810789b2fe591875f with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

Props

The prop schema is normative in packages/contracts/component-props/api-reference.schema.json.

Example props generated from this schema:

{
  "title": "example-title",
  "operation_id": "example-operation_id",
  "schema_ref": "example-schema_ref",
  "language_examples": [
    {
      "language": "example-language",
      "code": "echo hello"
    }
  ]
}

Required props: operation_id, schema_ref.

Example

Example document IR (the block the renderer consumes):

{
  "type": "api-reference",
  "props": {
    "title": "example-title",
    "operation_id": "example-operation_id",
    "schema_ref": "example-schema_ref",
    "language_examples": [
      {
        "language": "example-language",
        "code": "echo hello"
      }
    ]
  }
}

Renderer HTML (entities decoded and wrapped for display):

<section class="ds-block ds-api-reference" data-component="api-reference" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Operation</dt>
<dd>
<code>example-operation_id</code>
</dd>
</div>
<div>
<dt>Schema</dt>
<dd>
<code>example-schema_ref</code>
</dd>
</div>
</dl>
<div class="ds-group">
<h4 class="ds-block-subtitle">example-language</h4>
<pre class="ds-code" data-lang="example-language">
<code>echo hello</code>
</pre>
</div>
</section>

Preview (interface-only; the markup above is the same output):

echo hello

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

Specification

Generated from packages/contracts/component-specs/api-reference.md.

Contract

Production props are normative in ../contracts/component-props/api-reference.schema.json. The corresponding component-fixtures manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated component-package.json manifest plus props.schema.json (the production props schema, copied byte-for-byte) and spec.md (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

Intended behavior

Render deterministic method, path, auth, constraints, request/response/errors from snapshot contract.

Failure and fallback

Unsupported schema keywords marked, not dropped into wrong reference.

Required acceptance cases

Rendered required/default/nullable match schema fixture. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

Package manifest

Protocol fixture: packages/contracts/component-fixtures/api-reference.json.

Sources