software.amazon.awscdk.services.apigateway

Interface JsonSchema

All Known Implementing Classes:

JsonSchema.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-21T22:31:07.756Z")
public interface JsonSchema

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 and Description
static class	JsonSchema.Builder A builder for JsonSchema
static class	JsonSchema.Jsii$Proxy An implementation for JsonSchema

Method Summary

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

Method Detail

getAdditionalItems

default java.util.List<JsonSchema> getAdditionalItems()

getAdditionalProperties

default java.lang.Object getAdditionalProperties()

getAllOf

default java.util.List<JsonSchema> getAllOf()

getAnyOf

default java.util.List<JsonSchema> getAnyOf()

getContains

default java.lang.Object getContains()

getDefaultValue

default java.lang.Object getDefaultValue()

The default value if you use an enum.

Default: - not set

getDefinitions

default java.util.Map<java.lang.String,JsonSchema> getDefinitions()

getDependencies

default java.util.Map<java.lang.String,java.lang.Object> getDependencies()

getDescription

default java.lang.String getDescription()

getEnumValue

default java.util.List<java.lang.Object> getEnumValue()

getExclusiveMaximum

default java.lang.Boolean getExclusiveMaximum()

getExclusiveMinimum

default java.lang.Boolean getExclusiveMinimum()

getFormat

default java.lang.String getFormat()

getId

default java.lang.String getId()

getItems

default java.lang.Object getItems()

getMaximum

default java.lang.Number getMaximum()

getMaxItems

default java.lang.Number getMaxItems()

getMaxLength

default java.lang.Number getMaxLength()

getMaxProperties

default java.lang.Number getMaxProperties()

getMinimum

default java.lang.Number getMinimum()

getMinItems

default java.lang.Number getMinItems()

getMinLength

default java.lang.Number getMinLength()

getMinProperties

default java.lang.Number getMinProperties()

getMultipleOf

default java.lang.Number getMultipleOf()

getNot

default JsonSchema getNot()

getOneOf

default java.util.List<JsonSchema> getOneOf()

getPattern

default java.lang.String getPattern()

getPatternProperties

default java.util.Map<java.lang.String,JsonSchema> getPatternProperties()

getProperties

default java.util.Map<java.lang.String,JsonSchema> getProperties()

getPropertyNames

default JsonSchema getPropertyNames()

getRef

default java.lang.String getRef()

getRequired

default java.util.List<java.lang.String> getRequired()

getSchema

default JsonSchemaVersion getSchema()

getTitle

default java.lang.String getTitle()

getType

default java.lang.Object getType()

getUniqueItems

default java.lang.Boolean getUniqueItems()

builder

static JsonSchema.Builder builder()

Returns:

a JsonSchema.Builder of JsonSchema