schema-components 1.28.1 → 1.29.0

package/dist/html/streamRenderers.d.mts

@@ -1,13 +1,41 @@
-import { j as WalkedField } from "../types-BTB73MB8.mjs";
-import { i as DiagnosticsOptions } from "../diagnostics-Cbwak-ZX.mjs";
-import { o as HtmlResolver } from "../renderer-Ul9taFYp.mjs";
+import { j as WalkedField } from "../types-C2Ay1FEh.mjs";
+import { i as DiagnosticsOptions } from "../diagnostics-ByEzkjrA.mjs";
+import { o as HtmlResolver } from "../renderer-OaOz-n6-.mjs";
 import { HtmlElement } from "./html.mjs";
 
 //#region src/html/streamRenderers.d.ts
+/**
+ * Serialise the opening tag of an element so a generator can yield it
+ * without the matching closing tag. Void elements (e.g. `input`) are
+ * emitted self-closed so the chunk is structurally valid on its own.
+ */
 declare function yieldOpen(el: HtmlElement): string;
+/**
+ * Serialise the closing tag of an element so a generator can yield it
+ * after its children. Returns an empty string for void elements (their
+ * opening tag was emitted self-closed by {@link yieldOpen}).
+ */
 declare function yieldClose(el: HtmlElement): string;
+/**
+ * Render a leaf {@link WalkedField} entirely as a single HTML chunk.
+ * Used inside the streaming generators when descent into containers is
+ * complete. Falls back to a `<span>`-wrapped value when no renderer is
+ * registered for the field type.
+ */
 declare function renderLeaf(tree: WalkedField, value: unknown, mergedResolver: HtmlResolver, path: string): string;
+/**
+ * Drain {@link streamField} into a single string. Used when a streamed
+ * sub-tree needs to be embedded inside a non-streaming chunk (e.g. as
+ * children of a parent element).
+ */
 declare function renderFieldSync(tree: WalkedField, value: unknown, mergedResolver: HtmlResolver, path: string, rawResolver: HtmlResolver, currentDepth: number, diagnostics: DiagnosticsOptions | undefined): string;
+/**
+ * Render a {@link WalkedField} as a generator that yields HTML chunks
+ * at natural boundaries (opening tag, one chunk per child, closing
+ * tag). Threads `currentDepth` so cyclic walked-field graphs terminate
+ * at `MAX_RENDER_DEPTH` with a recursion sentinel rather than
+ * overflowing the stack.
+ */
 declare function streamField(tree: WalkedField, value: unknown, mergedResolver: HtmlResolver, path: string, rawResolver: HtmlResolver, currentDepth?: number, diagnostics?: DiagnosticsOptions): Iterable<string, void, undefined>;
 //#endregion
 export { renderFieldSync, renderLeaf, streamField, yieldClose, yieldOpen };

package/dist/html/streamRenderers.mjs

@@ -9,15 +9,31 @@ import { ariaLabelAttrs, buildHintElement, buildInputId, joinPath, requiredIndic
 import { panelId, tabId } from "./renderers.mjs";
 import { recursionSentinelHtml } from "./renderToHtml.mjs";
 //#region src/html/streamRenderers.ts
+/**
+* Serialise the opening tag of an element so a generator can yield it
+* without the matching closing tag. Void elements (e.g. `input`) are
+* emitted self-closed so the chunk is structurally valid on its own.
+*/
 function yieldOpen(el) {
 	const attrStr = serializeAttributes(el.attributes);
 	if (VOID_ELEMENTS.has(el.tag)) return `<${el.tag}${attrStr} />`;
 	return `<${el.tag}${attrStr}>`;
 }
+/**
+* Serialise the closing tag of an element so a generator can yield it
+* after its children. Returns an empty string for void elements (their
+* opening tag was emitted self-closed by {@link yieldOpen}).
+*/
 function yieldClose(el) {
 	if (VOID_ELEMENTS.has(el.tag)) return "";
 	return `</${el.tag}>`;
 }
+/**
+* Render a leaf {@link WalkedField} entirely as a single HTML chunk.
+* Used inside the streaming generators when descent into containers is
+* complete. Falls back to a `<span>`-wrapped value when no renderer is
+* registered for the field type.
+*/
 function renderLeaf(tree, value, mergedResolver, path) {
 	const renderFn = getHtmlRenderFn(tree.type, mergedResolver);
 	if (renderFn !== void 0) return renderFn({
@@ -33,6 +49,11 @@ function renderLeaf(tree, value, mergedResolver, path) {
 	if (value === void 0 || value === null) return serialize(h("span", { class: SC_CLASSES.valueEmpty }, "—"));
 	return serialize(h("span", { class: SC_CLASSES.value }, typeof value === "string" ? value : JSON.stringify(value)));
 }
+/**
+* Drain {@link streamField} into a single string. Used when a streamed
+* sub-tree needs to be embedded inside a non-streaming chunk (e.g. as
+* children of a parent element).
+*/
 function renderFieldSync(tree, value, mergedResolver, path, rawResolver, currentDepth, diagnostics) {
 	return [...streamField(tree, value, mergedResolver, path, rawResolver, currentDepth, diagnostics)].join("");
 }
@@ -51,6 +72,13 @@ function typeMismatchPlaceholder(expectedShape) {
 		role: "alert"
 	}, `invalid value (expected ${expectedShape})`));
 }
+/**
+* Render a {@link WalkedField} as a generator that yields HTML chunks
+* at natural boundaries (opening tag, one chunk per child, closing
+* tag). Threads `currentDepth` so cyclic walked-field graphs terminate
+* at `MAX_RENDER_DEPTH` with a recursion sentinel rather than
+* overflowing the stack.
+*/
 function* streamField(tree, value, mergedResolver, path, rawResolver, currentDepth = 0, diagnostics) {
 	if (currentDepth >= 10) {
 		yield recursionSentinelHtml(typeof tree.meta.description === "string" ? tree.meta.description : "schema");

package/dist/{limits-DJhgx5Ay.d.mts → limits-DswmqWuy.d.mts}

@@ -18,6 +18,7 @@ declare const MAX_RENDER_DEPTH = 10;
  * and compile-time bounds agree.
  */
 type MaxRefDepth = 64;
+/** Runtime constant matching the type-level {@link MaxRefDepth} bound. */
 declare const MAX_REF_DEPTH: MaxRefDepth;
 /**
  * Maximum number of `$ref` hops permitted when walking a chain of

package/dist/openapi/ApiCallbacks.d.mts

@@ -1,14 +1,26 @@
-import { w as SchemaMeta } from "../types-BTB73MB8.mjs";
+import { w as SchemaMeta } from "../types-C2Ay1FEh.mjs";
 import { CallbackInfo } from "./parser.mjs";
 import { ReactNode } from "react";
 
 //#region src/openapi/ApiCallbacks.d.ts
+/**
+ * Props accepted by {@link ApiCallbacks}.
+ *
+ * @group OpenAPI
+ */
 interface ApiCallbacksProps {
   /** Callback definitions for this operation. */
   callbacks: CallbackInfo[];
   /** Optional meta overrides. */
   meta?: SchemaMeta;
 }
+/**
+ * Render OpenAPI callback definitions declared on an operation. Each
+ * callback name is displayed alongside its operations. Read-only —
+ * intended for documentation rather than interactive editing.
+ *
+ * @group OpenAPI
+ */
 declare function ApiCallbacks({
   callbacks
 }: ApiCallbacksProps): ReactNode;

package/dist/openapi/ApiCallbacks.mjs

@@ -1,5 +1,12 @@
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/openapi/ApiCallbacks.tsx
+/**
+* Render OpenAPI callback definitions declared on an operation. Each
+* callback name is displayed alongside its operations. Read-only —
+* intended for documentation rather than interactive editing.
+*
+* @group OpenAPI
+*/
 function ApiCallbacks({ callbacks }) {
 	if (callbacks.length === 0) return null;
 	return /* @__PURE__ */ jsxs("section", {

package/dist/openapi/ApiLinks.d.mts

@@ -1,14 +1,26 @@
-import { w as SchemaMeta } from "../types-BTB73MB8.mjs";
+import { w as SchemaMeta } from "../types-C2Ay1FEh.mjs";
 import { LinkInfo } from "./parser.mjs";
 import { ReactNode } from "react";
 
 //#region src/openapi/ApiLinks.d.ts
+/**
+ * Props accepted by {@link ApiLinks}.
+ *
+ * @group OpenAPI
+ */
 interface ApiLinksProps {
   /** Link definitions for a response. */
   links: LinkInfo[];
   /** Optional meta overrides. */
   meta?: SchemaMeta;
 }
+/**
+ * Render OpenAPI link definitions attached to a response. Displays each
+ * link's name, target operation (`operationId` or `operationRef`),
+ * description, and parameter mappings. Read-only.
+ *
+ * @group OpenAPI
+ */
 declare function ApiLinks({
   links
 }: ApiLinksProps): ReactNode;

package/dist/openapi/ApiLinks.mjs

@@ -1,5 +1,12 @@
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/openapi/ApiLinks.tsx
+/**
+* Render OpenAPI link definitions attached to a response. Displays each
+* link's name, target operation (`operationId` or `operationRef`),
+* description, and parameter mappings. Read-only.
+*
+* @group OpenAPI
+*/
 function ApiLinks({ links }) {
 	if (links.length === 0) return null;
 	return /* @__PURE__ */ jsxs("section", {

package/dist/openapi/ApiResponseHeaders.d.mts

@@ -1,14 +1,26 @@
-import { w as SchemaMeta } from "../types-BTB73MB8.mjs";
+import { w as SchemaMeta } from "../types-C2Ay1FEh.mjs";
 import { HeaderInfo } from "./parser.mjs";
 import { ReactNode } from "react";
 
 //#region src/openapi/ApiResponseHeaders.d.ts
+/**
+ * Props accepted by {@link ApiResponseHeaders}.
+ *
+ * @group OpenAPI
+ */
 interface ApiResponseHeadersProps {
   /** Header definitions for a response. */
   headers: Map<string, HeaderInfo>;
   /** Optional meta overrides. */
   meta?: SchemaMeta;
 }
+/**
+ * Render the header definitions declared on an OpenAPI response. Shows
+ * each header's name, description, type, required flag, and deprecation
+ * marker. Read-only.
+ *
+ * @group OpenAPI
+ */
 declare function ApiResponseHeaders({
   headers
 }: ApiResponseHeadersProps): ReactNode;

package/dist/openapi/ApiResponseHeaders.mjs

@@ -1,5 +1,12 @@
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/openapi/ApiResponseHeaders.tsx
+/**
+* Render the header definitions declared on an OpenAPI response. Shows
+* each header's name, description, type, required flag, and deprecation
+* marker. Read-only.
+*
+* @group OpenAPI
+*/
 function ApiResponseHeaders({ headers }) {
 	if (headers.size === 0) return null;
 	return /* @__PURE__ */ jsxs("section", {

package/dist/openapi/ApiSecurity.d.mts

@@ -1,8 +1,13 @@
-import { w as SchemaMeta } from "../types-BTB73MB8.mjs";
+import { w as SchemaMeta } from "../types-C2Ay1FEh.mjs";
 import { SecurityRequirement, SecurityScheme } from "./parser.mjs";
 import { ReactNode } from "react";
 
 //#region src/openapi/ApiSecurity.d.ts
+/**
+ * Props accepted by {@link ApiSecurity}.
+ *
+ * @group OpenAPI
+ */
 interface ApiSecurityProps {
   /** Security requirements for this operation. */
   requirements: SecurityRequirement[];
@@ -11,6 +16,14 @@ interface ApiSecurityProps {
   /** Optional meta overrides. */
   meta?: SchemaMeta;
 }
+/**
+ * Render the security requirements that apply to an OpenAPI operation,
+ * resolved against the document's component security schemes. Displays
+ * each scheme's type, description, location, scopes, and the full set
+ * of OAuth 2 flows when applicable. Read-only.
+ *
+ * @group OpenAPI
+ */
 declare function ApiSecurity({
   requirements,
   schemes

package/dist/openapi/ApiSecurity.mjs

@@ -53,6 +53,14 @@ function extractFlows(flows) {
 	}
 	return result;
 }
+/**
+* Render the security requirements that apply to an OpenAPI operation,
+* resolved against the document's component security schemes. Displays
+* each scheme's type, description, location, scopes, and the full set
+* of OAuth 2 flows when applicable. Read-only.
+*
+* @group OpenAPI
+*/
 function ApiSecurity({ requirements, schemes }) {
 	if (requirements.length === 0) return null;
 	return /* @__PURE__ */ jsxs("section", {

package/dist/openapi/components.d.mts

@@ -1,5 +1,5 @@
-import { u as FieldOverride, w as SchemaMeta } from "../types-BTB73MB8.mjs";
-import { r as DiagnosticSink } from "../diagnostics-Cbwak-ZX.mjs";
+import { u as FieldOverride, w as SchemaMeta } from "../types-C2Ay1FEh.mjs";
+import { r as DiagnosticSink } from "../diagnostics-ByEzkjrA.mjs";
 import { InferParameterOverrides, InferRequestBodyFields, InferResponseFields } from "../core/typeInference.mjs";
 import { WidgetMap } from "../react/SchemaComponent.mjs";
 import { ReactNode } from "react";
@@ -168,6 +168,11 @@ interface ApiDiagnosticsProps {
   onDiagnostic?: DiagnosticSink;
   strict?: boolean;
 }
+/**
+ * Props accepted by {@link ApiOperation}.
+ *
+ * @group OpenAPI
+ */
 interface ApiOperationProps<Doc = unknown, Path extends PathKeysOf<Doc> = PathKeysOf<Doc>, Method extends MethodKeysOf<Doc, Path> = MethodKeysOf<Doc, Path>, ContentType extends RequestContentTypesOf<Doc, Path, Method> = RequestContentTypesOf<Doc, Path, Method>> extends ApiDiagnosticsProps {
   schema: Doc;
   path: Path;
@@ -189,6 +194,25 @@ interface ApiOperationProps<Doc = unknown, Path extends PathKeysOf<Doc> = PathKe
   /** Instance-scoped widgets. */
   widgets?: WidgetMap;
 }
+/**
+ * Render a single OpenAPI operation — header, parameters, request body,
+ * responses, callbacks, security, and external docs — picked out of a
+ * supplied document by `path` and `method`.
+ *
+ * When `schema` is typed `as const`, `requestBodyFields` autocomplete
+ * resolves from the operation's request body schema. The component
+ * works with OpenAPI 2.0, 3.0, and 3.1 inputs (Swagger 2.0 documents
+ * are normalised to 3.1 internally) and also resolves OpenAPI 3.1
+ * webhooks under the same code path.
+ *
+ * @group OpenAPI
+ * @example
+ * ```tsx
+ * import { ApiOperation } from "schema-components/openapi/components";
+ *
+ * <ApiOperation schema={petStore} path="/pets" method="post" />
+ * ```
+ */
 declare function ApiOperation<Doc = unknown, Path extends PathKeysOf<Doc> = PathKeysOf<Doc>, Method extends MethodKeysOf<Doc, Path> = MethodKeysOf<Doc, Path>, ContentType extends RequestContentTypesOf<Doc, Path, Method> = RequestContentTypesOf<Doc, Path, Method>>({
   schema: doc,
   path,
@@ -202,6 +226,11 @@ declare function ApiOperation<Doc = unknown, Path extends PathKeysOf<Doc> = Path
   onDiagnostic,
   strict
 }: ApiOperationProps<Doc, Path, Method, ContentType>): ReactNode;
+/**
+ * Props accepted by {@link ApiParameters}.
+ *
+ * @group OpenAPI
+ */
 interface ApiParametersProps<Doc = unknown, Path extends PathKeysOf<Doc> = PathKeysOf<Doc>, Method extends MethodKeysOf<Doc, Path> = MethodKeysOf<Doc, Path>> extends ApiDiagnosticsProps {
   schema: Doc;
   path: Path;
@@ -211,6 +240,14 @@ interface ApiParametersProps<Doc = unknown, Path extends PathKeysOf<Doc> = PathK
   /** Instance-scoped widgets. */
   widgets?: WidgetMap;
 }
+/**
+ * Render the `parameters` of a single OpenAPI operation — path, query,
+ * header, and cookie parameters — picked out of `schema` by `path` and
+ * `method`. When the document is typed `as const`, the `overrides` prop
+ * autocompletes on each parameter name.
+ *
+ * @group OpenAPI
+ */
 declare function ApiParameters<Doc = unknown, Path extends PathKeysOf<Doc> = PathKeysOf<Doc>, Method extends MethodKeysOf<Doc, Path> = MethodKeysOf<Doc, Path>>({
   schema: doc,
   path,
@@ -221,6 +258,11 @@ declare function ApiParameters<Doc = unknown, Path extends PathKeysOf<Doc> = Pat
   onDiagnostic,
   strict
 }: ApiParametersProps<Doc, Path, Method>): ReactNode;
+/**
+ * Props accepted by {@link ApiRequestBody}.
+ *
+ * @group OpenAPI
+ */
 interface ApiRequestBodyProps<Doc = unknown, Path extends PathKeysOf<Doc> = PathKeysOf<Doc>, Method extends MethodKeysOf<Doc, Path> = MethodKeysOf<Doc, Path>, ContentType extends RequestContentTypesOf<Doc, Path, Method> = RequestContentTypesOf<Doc, Path, Method>> extends ApiDiagnosticsProps {
   schema: Doc;
   path: Path;
@@ -239,6 +281,17 @@ interface ApiRequestBodyProps<Doc = unknown, Path extends PathKeysOf<Doc> = Path
   /** Instance-scoped widgets. */
   widgets?: WidgetMap;
 }
+/**
+ * Render the request body of a single OpenAPI operation, picked out of
+ * `schema` by `path` and `method`. Returns `null` when the operation
+ * declares no request body or no resolvable schema.
+ *
+ * When `schema` is typed `as const`, `fields` autocomplete resolves
+ * from the request body schema; pass `contentType` to narrow inference
+ * to a specific media type.
+ *
+ * @group OpenAPI
+ */
 declare function ApiRequestBody<Doc = unknown, Path extends PathKeysOf<Doc> = PathKeysOf<Doc>, Method extends MethodKeysOf<Doc, Path> = MethodKeysOf<Doc, Path>, ContentType extends RequestContentTypesOf<Doc, Path, Method> = RequestContentTypesOf<Doc, Path, Method>>({
   schema: doc,
   path,
@@ -251,6 +304,11 @@ declare function ApiRequestBody<Doc = unknown, Path extends PathKeysOf<Doc> = Pa
   onDiagnostic,
   strict
 }: ApiRequestBodyProps<Doc, Path, Method, ContentType>): ReactNode;
+/**
+ * Props accepted by {@link ApiResponse}.
+ *
+ * @group OpenAPI
+ */
 interface ApiResponseProps<Doc = unknown, Path extends PathKeysOf<Doc> = PathKeysOf<Doc>, Method extends MethodKeysOf<Doc, Path> = MethodKeysOf<Doc, Path>, Status extends StatusKeysOf<Doc, Path, Method> = StatusKeysOf<Doc, Path, Method>, ContentType extends ResponseContentTypesOf<Doc, Path, Method, Status> = ResponseContentTypesOf<Doc, Path, Method, Status>> extends ApiDiagnosticsProps {
   schema: Doc;
   path: Path;
@@ -269,6 +327,18 @@ interface ApiResponseProps<Doc = unknown, Path extends PathKeysOf<Doc> = PathKey
   /** Instance-scoped widgets. */
   widgets?: WidgetMap;
 }
+/**
+ * Render the response schema for a single OpenAPI operation status —
+ * picked out of `schema` by `path`, `method`, and `status`.
+ *
+ * Status resolution follows the OpenAPI priority order: concrete code
+ * (e.g. `"200"`) > class wildcard (e.g. `"2XX"`) > `"default"`. When
+ * `schema` is typed `as const`, `fields` autocomplete resolves from
+ * the response schema; pass `contentType` to narrow inference to a
+ * specific media type.
+ *
+ * @group OpenAPI
+ */
 declare function ApiResponse<Doc = unknown, Path extends PathKeysOf<Doc> = PathKeysOf<Doc>, Method extends MethodKeysOf<Doc, Path> = MethodKeysOf<Doc, Path>, Status extends StatusKeysOf<Doc, Path, Method> = StatusKeysOf<Doc, Path, Method>, ContentType extends ResponseContentTypesOf<Doc, Path, Method, Status> = ResponseContentTypesOf<Doc, Path, Method, Status>>({
   schema: doc,
   path,
@@ -282,14 +352,9 @@ declare function ApiResponse<Doc = unknown, Path extends PathKeysOf<Doc> = PathK
   strict
 }: ApiResponseProps<Doc, Path, Method, Status, ContentType>): ReactNode;
 /**
- * Render a single OpenAPI 3.1 webhook by name. A webhook is a Path Item
- * Object under the document's top-level `webhooks` map; once resolved,
- * its operations are structurally identical to operations under `paths`.
+ * Props accepted by {@link ApiWebhook}.
  *
- * Internally, this delegates to `ApiOperation` for each method present
- * on the webhook's Path Item Object. The parser's `lookupPathItem`
- * resolves webhook names through the same code path as paths, so
- * `ApiOperation` works for both with no special-casing in the renderer.
+ * @group OpenAPI
  */
 interface ApiWebhookProps extends ApiDiagnosticsProps {
   schema: unknown;
@@ -299,6 +364,18 @@ interface ApiWebhookProps extends ApiDiagnosticsProps {
   widgets?: WidgetMap;
   meta?: SchemaMeta;
 }
+/**
+ * Render a single OpenAPI 3.1 webhook by name. A webhook is a Path Item
+ * Object under the document's top-level `webhooks` map; once resolved,
+ * its operations are structurally identical to operations under `paths`.
+ *
+ * Delegates to {@link ApiOperation} for each method present on the
+ * webhook's Path Item Object — the parser's `lookupPathItem` resolves
+ * webhook names through the same code path as paths, so `ApiOperation`
+ * works for both with no special-casing in the renderer.
+ *
+ * @group OpenAPI
+ */
 declare function ApiWebhook({
   schema: doc,
   name,
@@ -308,15 +385,22 @@ declare function ApiWebhook({
   strict
 }: ApiWebhookProps): ReactNode;
 /**
- * Render every OpenAPI 3.1 webhook declared on the document, one
- * `<ApiWebhook>` per entry. Returns `null` when the document has no
- * `webhooks` map or it is empty.
+ * Props accepted by {@link ApiWebhooks}.
+ *
+ * @group OpenAPI
  */
 interface ApiWebhooksProps extends ApiDiagnosticsProps {
   schema: unknown;
   widgets?: WidgetMap;
   meta?: SchemaMeta;
 }
+/**
+ * Render every OpenAPI 3.1 webhook declared on the document, one
+ * `<ApiWebhook>` per entry. Returns `null` when the document has no
+ * `webhooks` map or the map is empty.
+ *
+ * @group OpenAPI
+ */
 declare function ApiWebhooks({
   schema: doc,
   widgets,

package/dist/openapi/components.mjs

@@ -107,6 +107,25 @@ function SchemaXmlFootnote({ xml }) {
 		] })
 	});
 }
+/**
+* Render a single OpenAPI operation — header, parameters, request body,
+* responses, callbacks, security, and external docs — picked out of a
+* supplied document by `path` and `method`.
+*
+* When `schema` is typed `as const`, `requestBodyFields` autocomplete
+* resolves from the operation's request body schema. The component
+* works with OpenAPI 2.0, 3.0, and 3.1 inputs (Swagger 2.0 documents
+* are normalised to 3.1 internally) and also resolves OpenAPI 3.1
+* webhooks under the same code path.
+*
+* @group OpenAPI
+* @example
+* ```tsx
+* import { ApiOperation } from "schema-components/openapi/components";
+*
+* <ApiOperation schema={petStore} path="/pets" method="post" />
+* ```
+*/
 function ApiOperation({ schema: doc, path, method, requestBodyValue, onRequestBodyChange, responseValue, meta, requestBodyFields, widgets, onDiagnostic, strict }) {
 	const diagnostics = buildDiagnostics(onDiagnostic, strict);
 	const instancePrefix = sanitisePrefix(useId());
@@ -184,6 +203,14 @@ function ApiOperation({ schema: doc, path, method, requestBodyValue, onRequestBo
 		]
 	});
 }
+/**
+* Render the `parameters` of a single OpenAPI operation — path, query,
+* header, and cookie parameters — picked out of `schema` by `path` and
+* `method`. When the document is typed `as const`, the `overrides` prop
+* autocompletes on each parameter name.
+*
+* @group OpenAPI
+*/
 function ApiParameters({ schema: doc, path, method, meta, overrides, widgets, onDiagnostic, strict }) {
 	const diagnostics = buildDiagnostics(onDiagnostic, strict);
 	const instancePrefix = sanitisePrefix(useId());
@@ -205,6 +232,17 @@ function ApiParameters({ schema: doc, path, method, meta, overrides, widgets, on
 		})]
 	});
 }
+/**
+* Render the request body of a single OpenAPI operation, picked out of
+* `schema` by `path` and `method`. Returns `null` when the operation
+* declares no request body or no resolvable schema.
+*
+* When `schema` is typed `as const`, `fields` autocomplete resolves
+* from the request body schema; pass `contentType` to narrow inference
+* to a specific media type.
+*
+* @group OpenAPI
+*/
 function ApiRequestBody({ schema: doc, path, method, value, onChange, meta, fields, widgets, onDiagnostic, strict }) {
 	const diagnostics = buildDiagnostics(onDiagnostic, strict);
 	const instancePrefix = sanitisePrefix(useId());
@@ -237,6 +275,18 @@ function ApiRequestBody({ schema: doc, path, method, value, onChange, meta, fiel
 		]
 	});
 }
+/**
+* Render the response schema for a single OpenAPI operation status —
+* picked out of `schema` by `path`, `method`, and `status`.
+*
+* Status resolution follows the OpenAPI priority order: concrete code
+* (e.g. `"200"`) > class wildcard (e.g. `"2XX"`) > `"default"`. When
+* `schema` is typed `as const`, `fields` autocomplete resolves from
+* the response schema; pass `contentType` to narrow inference to a
+* specific media type.
+*
+* @group OpenAPI
+*/
 function ApiResponse({ schema: doc, path, method, status, value, meta, fields, widgets, onDiagnostic, strict }) {
 	const diagnostics = buildDiagnostics(onDiagnostic, strict);
 	const instancePrefix = sanitisePrefix(useId());
@@ -265,6 +315,18 @@ function ApiResponse({ schema: doc, path, method, status, value, meta, fields, w
 		idPrefix: instancePrefix
 	});
 }
+/**
+* Render a single OpenAPI 3.1 webhook by name. A webhook is a Path Item
+* Object under the document's top-level `webhooks` map; once resolved,
+* its operations are structurally identical to operations under `paths`.
+*
+* Delegates to {@link ApiOperation} for each method present on the
+* webhook's Path Item Object — the parser's `lookupPathItem` resolves
+* webhook names through the same code path as paths, so `ApiOperation`
+* works for both with no special-casing in the renderer.
+*
+* @group OpenAPI
+*/
 function ApiWebhook({ schema: doc, name, widgets, meta, onDiagnostic, strict }) {
 	const diagnostics = buildDiagnostics(onDiagnostic, strict);
 	const instancePrefix = sanitisePrefix(useId());
@@ -287,6 +349,13 @@ function ApiWebhook({ schema: doc, name, widgets, meta, onDiagnostic, strict })
 		})]
 	});
 }
+/**
+* Render every OpenAPI 3.1 webhook declared on the document, one
+* `<ApiWebhook>` per entry. Returns `null` when the document has no
+* `webhooks` map or the map is empty.
+*
+* @group OpenAPI
+*/
 function ApiWebhooks({ schema: doc, widgets, meta, onDiagnostic, strict }) {
 	const diagnostics = buildDiagnostics(onDiagnostic, strict);
 	const instancePrefix = sanitisePrefix(useId());