An operation response code.
The response codes are the HTTP response codes defined in RFC-2616. Typically, a limited set are used for REST.
Field Name |
Type |
Since Version |
Description |
code |
Long |
|
The response code |
reason |
String |
|
The response reason |
id |
String |
|
An identifier |
ref |
String |
|
A Reference to a definition on defitions object |
title |
String |
|
Shema title |
description |
String |
|
Description about the Schema |
defaultValue |
Object |
|
Default value for this schema if it is applicable |
type |
String |
|
The type ex: array , boolean, integer , null , number, object, string |
format |
String |
|
The format ex: int32, int64, float, double, byte, binary, date, date-time or password |
required |
[String] |
|
Specifies if the paramater is required |
properties |
{String, SchemaObject} |
|
Not used beacause our model does not support inline nested types |
items |
SchemaObject |
|
if the schema is an array specifies the items type |
example |
Object |
|
if the schema is an array specifies the items type |
exclusiveMinimum |
Boolean |
|
|
maxLength |
Int |
|
|
minLength |
Int |
|
|
pattern |
String |
|
|
maxItems |
Int |
|
|
minItems |
Int |
|
|
uniqueItems |
Boolean |
|
|
multipleOf |
Int |
|
|
collectionFormat |
String |
|
|
enumList |
[String] |
|
|
discriminator |
String |
|
none |
{
"id" : "",
"format" : "",
"code" : 404,
"reason" : "Not Found",
"$ref" : "#/definitions/User",
"type" : "string"
}