@salesforce/b2c-tooling-sdk / schemas / SchemaCollapseOptions

Interface: SchemaCollapseOptions

Defined in: packages/b2c-tooling-sdk/src/schemas/collapse.ts:24

Options for collapsing an OpenAPI schema.

Properties

expandExamples?

optional expandExamples: string[]

Defined in: packages/b2c-tooling-sdk/src/schemas/collapse.ts:44

Example names to fully expand (e.g., ["ProductExample"]). When provided, only these examples will have full content. Other examples will be shown as empty objects.

---

expandPaths?

optional expandPaths: string[]

Defined in: packages/b2c-tooling-sdk/src/schemas/collapse.ts:30

Paths to fully expand (e.g., ["/products", "/orders"]). When provided, only these paths will have full operation details. Other paths will show only their HTTP method names.

---

expandSchemas?

optional expandSchemas: string[]

Defined in: packages/b2c-tooling-sdk/src/schemas/collapse.ts:37

Schema names to fully expand (e.g., ["Product", "Order"]). When provided, only these schemas will have full definitions. Other schemas will be shown as empty objects.