---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../modules.md) / schemas

# schemas

OpenAPI Schema utilities for B2C Commerce.

Provides utilities for working with OpenAPI schemas, including
collapsing large schemas for context-efficient representation in
agentic/LLM scenarios.

## Schema Collapsing

Use [collapseOpenApiSchema](functions/collapseOpenApiSchema.md) to reduce the size of large OpenAPI schemas
while preserving structure for discovery:

```typescript
import { collapseOpenApiSchema } from '@salesforce/b2c-tooling-sdk/schemas';

// Collapse to outline form (default)
const collapsed = collapseOpenApiSchema(fullSchema);
// Result: paths show only ["get", "post"], schemas show only {}

// Selectively expand specific items
const collapsed = collapseOpenApiSchema(fullSchema, {
  expandPaths: ['/products/search'],
  expandSchemas: ['Product', 'SearchResult']
});
```

## Utility Functions

Helper functions for inspecting schemas:

```typescript
import {
  getPathKeys,
  getSchemaNames,
  isCollapsedSchema,
  getApiType
} from '@salesforce/b2c-tooling-sdk/schemas';

// Get available paths
const paths = getPathKeys(schema); // ["/products", "/orders", ...]

// Get available schemas
const schemas = getSchemaNames(schema); // ["Product", "Order", ...]

// Check if schema is collapsed
if (isCollapsedSchema(schema)) {
  console.log('Schema is in collapsed form');
}

// Map security scheme to API type
const apiType = getApiType('AmOAuth2'); // Returns 'Admin'
```

## Interfaces

- [CollapsedOpenApiSchema](interfaces/CollapsedOpenApiSchema.md)
- [OpenApiSchemaInput](interfaces/OpenApiSchemaInput.md)
- [SchemaCollapseOptions](interfaces/SchemaCollapseOptions.md)

## Type Aliases

- [CollapsedPath](type-aliases/CollapsedPath.md)

## Functions

- [collapseOpenApiSchema](functions/collapseOpenApiSchema.md)
- [getApiType](functions/getApiType.md)
- [getExampleNames](functions/getExampleNames.md)
- [getPathKeys](functions/getPathKeys.md)
- [getSchemaNames](functions/getSchemaNames.md)
- [isCollapsedSchema](functions/isCollapsedSchema.md)