Schema
@Documented @Retention(value=RUNTIME) @Deprecated public @interface Schema
Modifier and Type | Optional Element and Description |
---|---|
String[] |
_default
Deprecated.
|
String[] |
_enum
Deprecated.
|
String |
$ref
Deprecated.
|
String[] |
additionalProperties
Deprecated.
|
String[] |
allOf
Deprecated.
|
String |
collectionFormat
Deprecated.
|
String[] |
description
Deprecated.
|
String |
discriminator
Deprecated.
|
String[] |
example
Deprecated.
|
String[] |
examples
Deprecated.
|
boolean |
exclusiveMaximum
Deprecated.
|
boolean |
exclusiveMinimum
Deprecated.
|
ExternalDocs |
externalDocs
Deprecated.
|
String |
format
Deprecated.
|
boolean |
ignore
Deprecated.
Specifies that schema information for this part should not be shown in the generated Swagger documentation.
|
Items |
items
Deprecated.
|
String |
maximum
Deprecated.
|
long |
maxItems
Deprecated.
|
long |
maxLength
Deprecated.
|
long |
maxProperties
Deprecated.
|
String |
minimum
Deprecated.
|
long |
minItems
Deprecated.
|
long |
minLength
Deprecated.
|
long |
minProperties
Deprecated.
|
String |
multipleOf
Deprecated.
|
String |
pattern
Deprecated.
|
String[] |
properties
Deprecated.
|
boolean |
readOnly
Deprecated.
|
boolean |
required
Deprecated.
|
String |
title
Deprecated.
|
String |
type
Deprecated.
|
boolean |
uniqueItems
Deprecated.
|
String[] |
value
Deprecated.
Free-form value for the Swagger Schema Object.
|
String[] |
xml
Deprecated.
|
public abstract String $ref
A JSON reference to the schema definition.
public abstract String format
public abstract String title
public abstract String[] description
A brief description of the body. This could contain examples of use.
public abstract String[] _default
public abstract String multipleOf
public abstract String maximum
public abstract boolean exclusiveMaximum
public abstract String minimum
public abstract boolean exclusiveMinimum
public abstract long maxLength
public abstract long minLength
public abstract String pattern
public abstract long maxItems
public abstract long minItems
public abstract boolean uniqueItems
public abstract long maxProperties
public abstract long minProperties
public abstract boolean required
Determines whether this parameter is mandatory.
The property MAY be included and its default value is false.
public abstract String[] _enum
public abstract String type
public abstract Items items
public abstract String collectionFormat
Note that this field isn't part of the Swagger 2.0 specification, but the specification does not specify how items are supposed to be represented.
Determines the format of the array if type
Can only be used if type
is
Possible values are:
Static strings are defined in CollectionFormatType
.
Note that for collections/arrays parameters with POJO element types, the input is broken into a string array before being converted into POJO elements.
public abstract String[] allOf
public abstract String[] properties
public abstract String[] additionalProperties
public abstract String discriminator
public abstract boolean readOnly
public abstract String[] xml
public abstract ExternalDocs externalDocs
public abstract String[] example
A free-form property to include an example of an instance for this schema.
This attribute defines a JSON representation of the body value that is used by BasicRestInfoProvider
to construct
media-type-based examples of the body of the request.
public abstract String[] examples
This is a JSON object whose keys are media types and values are string representations of that value.
public abstract boolean ignore
public abstract String[] value
This is a JSON object that makes up the swagger information for this field.
The following are completely equivalent ways of defining the swagger description of a Schema object:
The reasons why you may want to use this field include:
{ }
characters are optional.
Copyright © 2018 Apache. All rights reserved.