What gets generated
This page is the field-by-field breakdown of what a sync produces from one OpenAPI operation: which spec fields become which block settings. See How the Sync Works for the bigger picture of what triggers a sync and what happens overall.
Endpoint block#
| From your spec | Becomes |
|---|---|
| Method and path | Method and Path |
summary | Summary |
description | Description |
deprecated | Mark as deprecated |
operationId | Operation ID (the deep-link anchor) |
security present on the operation | Requires authentication, turned on |
Version badge and Related Endpoints aren’t derived from anything in a standard OpenAPI operation, so a sync leaves them blank. Add those by hand if you want them.
Parameters block#
Built from both the operation’s parameters array and, separately, any object-shaped request body, since OpenAPI 3.x models body fields through requestBody‘s schema rather than as parameters entries.
| From your spec | Becomes |
|---|---|
name | Name |
schema.type | Type |
in (query, path, header, cookie), or body for a request body field | Location |
schema.format | Format |
schema.default | Default value |
schema.example | Example value |
schema.enum | Allowed values, joined into one comma-separated line |
schema.minimum/minLength | Minimum |
schema.maximum/maxLength | Maximum |
schema.pattern | Pattern |
required | Required |
deprecated | Deprecated |
schema.nullable, or type including "null" | Nullable |
schema.readOnly | Read-only |
schema.writeOnly | Write-only |
description | Description |
Nested properties of an object-type parameter or body field | Nested fields, one level deep |
A schema’s own title, for an object or array-of-object shape | Links to schema |
A schema using allOf, oneOf, or anyOf composition only contributes whatever plain fields it has outside of that composition. $ref pointers must already be resolved before your spec reaches the sync; this plugin’s conversion layer doesn’t resolve them itself.
Response Body block#
Only generated for responses that actually have a usable example. A response with just a description, and no example body, doesn’t get a row here (it still shows up in Status Codes below).
| From your spec | Becomes |
|---|---|
| The status code | Status code |
| The response’s content type (JSON preferred when more than one is present) | Content type |
| The example value, pretty-printed | Response body |
Named examples (the plural examples map) | Each becomes its own row, labeled with its summary or name |
The body schema’s top-level properties | Schema fields, turning on the Show Schema toggle |
The response’s headers map | Response headers |
When a response has multiple named examples for the same status and content type, every one of them becomes its own row rather than only the first.
Status Codes block#
Generated for every response the operation declares, whether or not it has an example.
| From your spec | Becomes |
|---|---|
| The status code | Status code |
A short label for well-known codes (e.g. 404 → Not Found) | Meaning |
The response’s description | Description |
| The response’s example, if any | Example response body |
Auth block#
Generated from the operation’s security requirement, matched against your spec’s components.securitySchemes. Only one Auth block is generated per operation, from the first security requirement the sync can model.
| Spec scheme type | Becomes |
|---|---|
http with scheme: bearer | Bearer token |
http with scheme: basic | Basic auth |
apiKey | API key header, using the scheme’s own header name |
oauth2 | OAuth 2.0 |
openIdConnect or mutualTLS | Skipped. No Auth block is generated for that operation. |
Servers block#
Generated once from your spec’s top-level servers array, not per operation.
| From your spec | Becomes |
|---|---|
url | Base URL |
description | Label |
A server URL containing variable placeholders, like https://{region}.api.example.com, comes through as plain text exactly as written.
What doesn’t get generated#
A sync only produces Endpoint, Parameters, Response Body, Status Codes, Auth, and Servers blocks, since those are the ones OpenAPI has a natural mapping for. Request/Response, Error Codes, Events, Try It, API Navigation, and Code Block aren’t generated by a sync. Add those by hand wherever you want them: Request/Response for hand-picked language examples, Error Codes for application-level error codes beyond plain HTTP status, Events for webhooks, Try It for a live console, API Navigation to list the Endpoint blocks a sync (or you) added to a page, and Code Block for any other code sample.