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

[@salesforce/b2c-tooling-sdk](../../modules.md) / [scapi](../index.md) / ScapiSchemaNeeds

# Interface: ScapiSchemaNeeds

Defined in: [packages/b2c-tooling-sdk/src/scapi/schema-source.ts:73](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/scapi/schema-source.ts#L73)

What a caller will do with a contract; used to ask the server for only that much.

## Properties

### customProperties?

> `optional` **customProperties**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/scapi/schema-source.ts:81](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/scapi/schema-source.ts#L81)

Tenant custom properties (`c_*` attributes).

***

### examples?

> `optional` **examples**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/scapi/schema-source.ts:79](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/scapi/schema-source.ts#L79)

Request and response examples.

***

### full?

> `optional` **full**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/scapi/schema-source.ts:75](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/scapi/schema-source.ts#L75)

The whole contract: every section (`all`). Overrides the other needs.

***

### prose?

> `optional` **prose**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/scapi/schema-source.ts:77](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/scapi/schema-source.ts#L77)

Operation, parameter and schema prose (`summaries`, `descriptions`, `titles`).