Package software.amazon.awscdk.services.apigateway

Interface JsonSchema

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JsonSchema.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:37.953Z")
@Stability(Stable)
public interface JsonSchema
extends software.amazon.jsii.JsiiSerializable

Represents a JSON schema definition of the structure of a REST API model.

Copied from npm module jsonschema.

Example:

 RestApi api;
 // We define the JSON Schema for the transformed valid response
 Model responseModel = api.addModel("ResponseModel", ModelOptions.builder()
         .contentType("application/json")
         .modelName("ResponseModel")
         .schema(JsonSchema.builder()
                 .schema(JsonSchemaVersion.DRAFT4)
                 .title("pollResponse")
                 .type(JsonSchemaType.OBJECT)
                 .properties(Map.of(
                         "state", JsonSchema.builder().type(JsonSchemaType.STRING).build(),
                         "greeting", JsonSchema.builder().type(JsonSchemaType.STRING).build()))
                 .build())
         .build());
 // We define the JSON Schema for the transformed error response
 Model errorResponseModel = api.addModel("ErrorResponseModel", ModelOptions.builder()
         .contentType("application/json")
         .modelName("ErrorResponseModel")
         .schema(JsonSchema.builder()
                 .schema(JsonSchemaVersion.DRAFT4)
                 .title("errorResponse")
                 .type(JsonSchemaType.OBJECT)
                 .properties(Map.of(
                         "state", JsonSchema.builder().type(JsonSchemaType.STRING).build(),
                         "message", JsonSchema.builder().type(JsonSchemaType.STRING).build()))
                 .build())
         .build());
 

See Also:

• https://github.com/tdegrunt/jsonschema

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	JsonSchema.Builder	A builder for JsonSchema
static final class	JsonSchema.Jsii$Proxy	An implementation for JsonSchema

Method Summary

Modifier and Type	Method	Description
static JsonSchema.Builder	builder()
default List<JsonSchema>	getAdditionalItems()
default Object	getAdditionalProperties()
default List<JsonSchema>	getAllOf()
default List<JsonSchema>	getAnyOf()
default Object	getContains()
default Object	getDefaultValue()	The default value if you use an enum.
default Map<String,JsonSchema>	getDefinitions()
default Map<String,Object>	getDependencies()
default String	getDescription()
default List<Object>	getEnumValue()
default Boolean	getExclusiveMaximum()
default Boolean	getExclusiveMinimum()
default String	getFormat()
default String	getId()
default Object	getItems()
default Number	getMaximum()
default Number	getMaxItems()
default Number	getMaxLength()
default Number	getMaxProperties()
default Number	getMinimum()
default Number	getMinItems()
default Number	getMinLength()
default Number	getMinProperties()
default Number	getMultipleOf()
default JsonSchema	getNot()
default List<JsonSchema>	getOneOf()
default String	getPattern()
default Map<String,JsonSchema>	getPatternProperties()
default Map<String,JsonSchema>	getProperties()
default JsonSchema	getPropertyNames()
default String	getRef()
default List<String>	getRequired()
default JsonSchemaVersion	getSchema()
default String	getTitle()
default Object	getType()
default Boolean	getUniqueItems()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalItems

@Stability(Stable)
@Nullable
default List<JsonSchema> getAdditionalItems()

getAdditionalProperties

@Stability(Stable)
@Nullable
default Object getAdditionalProperties()

getAllOf

@Stability(Stable)
@Nullable
default List<JsonSchema> getAllOf()

getAnyOf

@Stability(Stable)
@Nullable
default List<JsonSchema> getAnyOf()

getContains

@Stability(Stable)
@Nullable
default Object getContains()

getDefaultValue

@Stability(Stable)
@Nullable
default Object getDefaultValue()

The default value if you use an enum.

Default: - not set

getDefinitions

@Stability(Stable)
@Nullable
default Map<String,JsonSchema> getDefinitions()

getDependencies

@Stability(Stable)
@Nullable
default Map<String,Object> getDependencies()

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

getEnumValue

@Stability(Stable)
@Nullable
default List<Object> getEnumValue()

getExclusiveMaximum

@Stability(Stable)
@Nullable
default Boolean getExclusiveMaximum()

getExclusiveMinimum

@Stability(Stable)
@Nullable
default Boolean getExclusiveMinimum()

getFormat

@Stability(Stable)
@Nullable
default String getFormat()

getId

@Stability(Stable)
@Nullable
default String getId()

getItems

@Stability(Stable)
@Nullable
default Object getItems()

getMaximum

@Stability(Stable)
@Nullable
default Number getMaximum()

getMaxItems

@Stability(Stable)
@Nullable
default Number getMaxItems()

getMaxLength

@Stability(Stable)
@Nullable
default Number getMaxLength()

getMaxProperties

@Stability(Stable)
@Nullable
default Number getMaxProperties()

getMinimum

@Stability(Stable)
@Nullable
default Number getMinimum()

getMinItems

@Stability(Stable)
@Nullable
default Number getMinItems()

getMinLength

@Stability(Stable)
@Nullable
default Number getMinLength()

getMinProperties

@Stability(Stable)
@Nullable
default Number getMinProperties()

getMultipleOf

@Stability(Stable)
@Nullable
default Number getMultipleOf()

getNot

@Stability(Stable)
@Nullable
default JsonSchema getNot()

getOneOf

@Stability(Stable)
@Nullable
default List<JsonSchema> getOneOf()

getPattern

@Stability(Stable)
@Nullable
default String getPattern()

getPatternProperties

@Stability(Stable)
@Nullable
default Map<String,JsonSchema> getPatternProperties()

getProperties

@Stability(Stable)
@Nullable
default Map<String,JsonSchema> getProperties()

getPropertyNames

@Stability(Stable)
@Nullable
default JsonSchema getPropertyNames()

getRef

@Stability(Stable)
@Nullable
default String getRef()

getRequired

@Stability(Stable)
@Nullable
default List<String> getRequired()

getSchema

@Stability(Stable)
@Nullable
default JsonSchemaVersion getSchema()

getTitle

@Stability(Stable)
@Nullable
default String getTitle()

getType

@Stability(Stable)
@Nullable
default Object getType()

getUniqueItems

@Stability(Stable)
@Nullable
default Boolean getUniqueItems()

builder

@Stability(Stable)
static JsonSchema.Builder builder()

Returns:

a JsonSchema.Builder of JsonSchema