Parameters and contracts

Use DocumentParameters for API inputs whose identifiers, types, and explanations need the full reading width. Required and optional states use text; neither is a validation control. Nested paths retain their full names and state when their parent is needed.

classNamestringRequired

One complete class, including any selector or condition suffix.

modestringOptional

Use the active manifest’s default behavior when omitted.

range.start.characterintegerRequired when parent is provided

Zero-based UTF-16 code-unit offset. Keep the full path visible so readers can build the correct request object.

{  "type": "object",  "properties": { "className": { "type": "string", "minLength": 1 } },  "required": ["className"]}

<DocumentParameters label="Parameters" parameters={[  { name: 'className', type: 'string', requirement: 'Required', description: 'One complete class.' }]} /><DocumentDisclosure title="Complete input schema">  <Code lang="json">{schema}</Code></DocumentDisclosure>

Place both components in document flow, outside the layout being demonstrated. Use a plain sentence for an empty parameter list. Long code can scroll inside a disclosure; parameter descriptions wrap naturally. Keep the full contract in portable Markdown and search even when the page initially collapses it.

Used by class inspection, directive formatting, and CLI generation.