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

Function: collapseOpenApiSchema()

collapseOpenApiSchema(schema, options): CollapsedOpenApiSchema

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

Collapses an OpenAPI schema for context-efficient representation.

This function implements a three-tier disclosure model:

1. No options provided (default):

   • Paths: {"/products": ["get", "post"]} (method names only)
   • Schemas: {"Product": {}} (keys only)
   • Examples: {"ProductExample": {}} (keys only)

2. Selective expansion:

   • Only specified paths/schemas/examples are fully expanded
   • Everything else remains collapsed

Non-collapsible sections (info, servers, security, tags, etc.) are preserved as-is.

Parameters

schema

OpenApiSchemaInput

The OpenAPI schema to collapse

options

SchemaCollapseOptions = {}

Options controlling what to expand

Returns

CollapsedOpenApiSchema

The collapsed schema

Examples

// Collapse everything (default behavior)
const collapsed = collapseOpenApiSchema(fullSchema);

// Expand only /products path and Product schema
const collapsed = collapseOpenApiSchema(fullSchema, {
  expandPaths: ['/products'],
  expandSchemas: ['Product']
});