OPTIONS

RapiDoc properties

Spec
Schemas
schema-style
Controls the visual representation of complex JSON schemas in request and response panels. 'tree' provides an interactive collapsible tree view; 'table' renders structured tabular rows.Default: tree
Display schemas as visual table or tree hierarchy
default-schema-tab
Selects which tab is active by default, and listed first, for request bodies, responses and object parameters: 'schema' (data contract model) or 'example' (sample JSON payload).Default: example
Default active tab in request and response bodies
schema-expand-level
Initial depth level for auto-expanding complex nested schema properties and sub-objects (the default expands all levels).Default: 99999
Initial expansion depth for nested schemas
schema-hide-read-only
'default' hides read-only properties in request bodies while displaying them in response models and webhook callbacks. Set to 'never' to always display read-only fields across all payloads. Note: This does not affect example generation.Default: default
Hide read-only fields from request body schemas
schema-hide-write-only
'default' hides write-only properties in response bodies while displaying them in request payloads. Set to 'never' to always display write-only fields across all payloads. Note: This does not affect example generation.Default: default
Hide write-only fields from response body schemas
schema-description-expanded
Controls whether schema field constraints, validation rules, and descriptions are fully expanded by default or collapsed to a single line.Default: false
Display full multiline schema property descriptions by default
allow-schema-description-expand-toggle
Shows or hides the button allowing users to toggle between single-line summary and multi-line detailed schema property descriptions.Default: true
Show toggle button for multiline schema descriptions
Try & Servers
fill-request-fields-with-example
Pre-populates interactive request parameter inputs and request body fields using example values defined in the OpenAPI spec.Default: true
Pre-populate "Try" console parameters with sample values