@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
date="2022-08-09T19:16:42.071Z")
public interface JsonSchema
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());
Modifier and Type | Interface and Description |
---|---|
static class |
JsonSchema.Builder
A builder for
JsonSchema |
static class |
JsonSchema.Jsii$Proxy
An implementation for
JsonSchema |
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() |
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()
Default: - not set
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()
static JsonSchema.Builder builder()
JsonSchema.Builder
of JsonSchema