Home > cdk-rest-api-with-spec > JsonSchemaEx
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Extended aws_apigateway.JsonSchema.
Signature:
export interface JsonSchemaEx extends apigateway.JsonSchema Extends: apigateway.JsonSchema
Introduces the following new properties,
- example: example value.
- modelRef: reference to another IModel.
| Property | Modifiers | Type | Description |
|---|---|---|---|
| additionalItems? | JsonSchemaEx[] | (BETA) (Optional) Extension of additionalItems. | |
| additionalProperties? | boolean | JsonSchemaEx | (BETA) (Optional) Extension of additionalProperties. | |
| allOf? | JsonSchemaEx[] | (BETA) (Optional) Extension of allOf. | |
| anyOf? | JsonSchemaEx[] | (BETA) (Optional) Extension of anyOf. | |
| contains? | JsonSchemaEx | JsonSchemaEx[] | (BETA) (Optional) Extension of contains. | |
| definitions? | { [k: string]: JsonSchemaEx; } | (BETA) (Optional) Extension of definitions. | |
| dependencies? | { [k: string]: JsonSchemaEx | string[]; } | (BETA) (Optional) Extension of dependencies. | |
| example? | any | (BETA) (Optional) Example value. | |
| items? | JsonSchemaEx | JsonSchemaEx[] | (BETA) (Optional) Extension of items. | |
| modelRef? | apigateway.IModel | (BETA) (Optional) Reference to another aws_apigateway.IModel. | |
| not? | JsonSchemaEx | (BETA) (Optional) Extension of not. | |
| oneOf? | JsonSchemaEx[] | (BETA) (Optional) Extension of oneOf. | |
| patternProperties? | { [k: string]: JsonSchemaEx; } | (BETA) (Optional) Extension of patternProperties. | |
| properties? | { [k: string]: JsonSchemaEx; } | (BETA) (Optional) Extension of properties. | |
| propertyNames? | JsonSchemaEx | (BETA) (Optional) Extension of propertyNames. |