Moved Example column to description content

This commit is contained in:
Hugo de Paix de Coeur
2016-04-06 19:16:17 +02:00
parent ae3f9aa353
commit 105ac545b3
13 changed files with 375 additions and 291 deletions

View File

@@ -129,8 +129,7 @@ public abstract class MarkupDocumentBuilder {
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6"),
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(EXAMPLE_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
if (MapUtils.isNotEmpty(properties)) {
Set<String> propertyNames = toKeySet(properties, config.getPropertyOrdering());
for (String propertyName : propertyNames) {
@@ -159,12 +158,21 @@ public abstract class MarkupDocumentBuilder {
propertyNameContent.italicText(FLAGS_READ_ONLY.toLowerCase());
}
MarkupDocBuilder descriptionContent = markupDocBuilder.copy(false);
String description = swaggerMarkupDescription(defaultString(property.getDescription()));
if (isNotBlank(description))
descriptionContent.text(description);
if (example != null) {
if (isNotBlank(description))
descriptionContent.newLine(true);
descriptionContent.boldText(EXAMPLE_COLUMN).text(COLON).literalText(Json.pretty(example));
}
List<String> content = Arrays.asList(
propertyNameContent.toString(),
swaggerMarkupDescription(defaultString(property.getDescription())),
descriptionContent.toString(),
propertyType.displaySchema(docBuilder),
PropertyUtils.getDefaultValue(property),
example != null ? Json.pretty(example) : ""
PropertyUtils.getDefaultValue(property)
);
cells.add(content);
}

View File

@@ -5,93 +5,93 @@
[[_category]]
=== Category
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*name* +
_optional_||string||
_optional_||string|
|===
[[_order]]
=== Order
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*complete* +
_optional_||boolean||
_optional_||boolean|
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*petId* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*quantity* +
_optional_||integer(int32)||
_optional_||integer(int32)|
|*shipDate* +
_optional_||string(date-time)||
_optional_||string(date-time)|
|*status* +
_optional_|Order Status|enum (Ordered, Cancelled)||
_optional_|Order Status|enum (Ordered, Cancelled)|
|===
[[_pet]]
=== Pet
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*category* +
_optional_||<<_category,Category>>||
_optional_||<<_category,Category>>|
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*name* +
_required_||string||"doggie"
_required_|*Example* : `"doggie"`|string|
|*photoUrls* +
_required_||string array||
_required_||string array|
|*status* +
_optional_|pet status in the store,|enum (Dead, Alive)||
_optional_|pet status in the store,|enum (Dead, Alive)|
|*tags* +
_optional_||<<_tag,Tag>> array||
_optional_||<<_tag,Tag>> array|
|===
[[_tag]]
=== Tag
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*name* +
_optional_||string||
_optional_||string|
|===
[[_user]]
=== User
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*email* +
_optional_||string||
_optional_||string|
|*firstName* +
_optional_||string||
_optional_||string|
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*lastName* +
_optional_||string||
_optional_||string|
|*password* +
_optional_||string||
_optional_||string|
|*phone* +
_optional_||string||
_optional_||string|
|*userStatus* +
_optional_|User Status|integer(int32)||
_optional_|User Status|integer(int32)|
|*username* +
_optional_||string||
_optional_||string|
|===

View File

@@ -27,11 +27,11 @@ _optional_|State as enum in object|<<_createstate_statemodel,StateModel>>|
[[_createstate_statemodel]]
*StateModel*
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*value* +
_optional_|State value|enum (ADDED, REMOVED, CHANGED)||
_optional_|State value|enum (ADDED, REMOVED, CHANGED)|
|===

View File

@@ -5,45 +5,69 @@
[[_category]]
=== Category
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||123
_optional_|*Example* : `123`|integer(int64)|
|*name* +
_optional_||string||"Canines"
_optional_|*Example* : `"Canines"`|string|
|===
[[_complexobject]]
=== ComplexObject
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default
|*subObject* +
_optional_||<<_complexobject_subobject,subObject>>|
|===
[[_complexobject_subobject]]
*subObject*
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default
|*id* +
_optional_|*Example* : `88`|integer(int64)|
|*value* +
_optional_|*Example* : `"a value !"`|string|
|===
[[_identified]]
=== Identified
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|===
[[_order]]
=== Order
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*complete* +
_optional_||boolean||
_optional_||boolean|
|*id* +
_optional_||integer(int64)||77
_optional_|*Example* : `77`|integer(int64)|
|*petId* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*quantity* +
_optional_||integer(int32)||
_optional_||integer(int32)|
|*shipDate* +
_optional_||string(date-time)||
_optional_||string(date-time)|
|*status* +
_optional_|Order Status|string||"DONE"
_optional_|Order Status +
*Example* : `"DONE"`|string|
|===
@@ -52,38 +76,38 @@ _optional_|Order Status|string||"DONE"
Test description
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*category* +
_optional_||<<_category,Category>>||
_optional_||<<_category,Category>>|
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*name* +
_required_||string||"doggie"
_required_|*Example* : `"doggie"`|string|
|*nicknames* +
_optional_||<string,string> map||
_optional_||<string,string> map|
|*photoUrls* +
_required_||string array||
_required_||string array|
|*status* +
_optional_|pet status in the store|string||
_optional_|pet status in the store|string|
|*tags* +
_optional_||<<_tag,Tag>> array||
_optional_||<<_tag,Tag>> array|
|*weight* +
_optional_|the weight of the pet|number||
_optional_|the weight of the pet|number|
|===
[[_tag]]
=== Tag
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*name* +
_optional_||string||
_optional_||string|
|===
@@ -93,27 +117,27 @@ _optional_||string||
_Polymorphism_ : Composition
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*email* +
_optional_||string||
_optional_||string|
|*firstName* +
_optional_||string||
_optional_||string|
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*lastName* +
_optional_||string||
_optional_||string|
|*password* +
_optional_||string||
_optional_||string|
|*phone* +
_optional_||string||
_optional_||string|
|*pictures* +
_optional_||string(byte) array||
_optional_||string(byte) array|
|*userStatus* +
_optional_|User Status|integer(int32)||
_optional_|User Status|integer(int32)|
|*username* +
_optional_||string||
_optional_||string|
|===

View File

@@ -5,45 +5,69 @@
[[_category]]
=== Category
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||123
_optional_|*Example* : `123`|integer(int64)|
|*name* +
_optional_||string||"Canines"
_optional_|*Example* : `"Canines"`|string|
|===
[[_complexobject]]
=== ComplexObject
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default
|*subObject* +
_optional_|*Example* : `"object"`|<<_complexobject_subobject,subObject>>|
|===
[[_complexobject_subobject]]
*subObject*
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default
|*id* +
_optional_|*Example* : `88`|integer(int64)|
|*value* +
_optional_|*Example* : `"a value !"`|string|
|===
[[_identified]]
=== Identified
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|===
[[_order]]
=== Order
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*complete* +
_optional_||boolean||true
_optional_|*Example* : `true`|boolean|
|*id* +
_optional_||integer(int64)||77
_optional_|*Example* : `77`|integer(int64)|
|*petId* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*quantity* +
_optional_||integer(int32)||0
_optional_|*Example* : `0`|integer(int32)|
|*shipDate* +
_optional_||string(date-time)||"string"
_optional_|*Example* : `"string"`|string(date-time)|
|*status* +
_optional_|Order Status|string||"DONE"
_optional_|Order Status +
*Example* : `"DONE"`|string|
|===
@@ -52,40 +76,42 @@ _optional_|Order Status|string||"DONE"
Test description
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*category* +
_optional_||<<_category,Category>>||"<<_category>>"
_optional_|*Example* : `"<<_category>>"`|<<_category,Category>>|
|*id* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*name* +
_required_||string||"doggie"
_required_|*Example* : `"doggie"`|string|
|*nicknames* +
_optional_||<string,string> map||{
_optional_|*Example* : `{
"string" : "string"
}
}`|<string,string> map|
|*photoUrls* +
_required_||string array||[ "string" ]
_required_|*Example* : `[ "string" ]`|string array|
|*status* +
_optional_|pet status in the store|string||"string"
_optional_|pet status in the store +
*Example* : `"string"`|string|
|*tags* +
_optional_||<<_tag,Tag>> array||[ "<<_tag>>" ]
_optional_|*Example* : `[ "<<_tag>>" ]`|<<_tag,Tag>> array|
|*weight* +
_optional_|the weight of the pet|number||0.0
_optional_|the weight of the pet +
*Example* : `0.0`|number|
|===
[[_tag]]
=== Tag
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*name* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|===
@@ -95,27 +121,28 @@ _optional_||string||"string"
_Polymorphism_ : Composition
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*email* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*firstName* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*id* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*lastName* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*password* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*phone* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*pictures* +
_optional_||string(byte) array||[ "string" ]
_optional_|*Example* : `[ "string" ]`|string(byte) array|
|*userStatus* +
_optional_|User Status|integer(int32)||0
_optional_|User Status +
*Example* : `0`|integer(int32)|
|*username* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|===

View File

@@ -5,93 +5,93 @@
[[_category]]
=== Category
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*name* +
_optional_||string||
_optional_||string|
|===
[[_order]]
=== Order
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*complete* +
_optional_||boolean||
_optional_||boolean|
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*petId* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*quantity* +
_optional_||integer(int32)||
_optional_||integer(int32)|
|*shipDate* +
_optional_||string(date-time)||
_optional_||string(date-time)|
|*status* +
_optional_|Order Status|enum (Ordered, Cancelled)||
_optional_|Order Status|enum (Ordered, Cancelled)|
|===
[[_pet]]
=== Pet
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*category* +
_optional_||<<_category,Category>>||
_optional_||<<_category,Category>>|
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*name* +
_required_||string||"doggie"
_required_|*Example* : `"doggie"`|string|
|*photoUrls* +
_required_||string array||
_required_||string array|
|*status* +
_optional_|pet status in the store,|enum (Dead, Alive)||
_optional_|pet status in the store,|enum (Dead, Alive)|
|*tags* +
_optional_||<<_tag,Tag>> array||
_optional_||<<_tag,Tag>> array|
|===
[[_tag]]
=== Tag
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*name* +
_optional_||string||
_optional_||string|
|===
[[_user]]
=== User
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*email* +
_optional_||string||
_optional_||string|
|*firstName* +
_optional_||string||
_optional_||string|
|*id* +
_optional_||integer(int64)||
_optional_||integer(int64)|
|*lastName* +
_optional_||string||
_optional_||string|
|*password* +
_optional_||string||
_optional_||string|
|*phone* +
_optional_||string||
_optional_||string|
|*userStatus* +
_optional_|User Status|integer(int32)||
_optional_|User Status|integer(int32)|
|*username* +
_optional_||string||
_optional_||string|
|===

View File

@@ -5,70 +5,70 @@
[[_error]]
=== Error
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*error-code* +
_optional_|Error code|integer||
_optional_|Error code|integer|
|*message* +
_optional_|Error message|string||
_optional_|Error message|string|
|===
[[_externallocation]]
=== ExternalLocation
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*Place* +
_optional_|Place|string||
_optional_|Place|string|
|===
[[_inlinedepthschema]]
=== InlineDepthSchema
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*Loop* +
_optional_||<<_inlinedepthschema_loop,Loop>>||
_optional_||<<_inlinedepthschema_loop,Loop>>|
|===
[[_inlinedepthschema_loop]]
*Loop*
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*p1* +
_optional_|Description p1|string||
_optional_|Description p1|string|
|*p2* +
_optional_|Description p2|<<_inlinedepthschema_p2,p2>>||
_optional_|Description p2|<<_inlinedepthschema_p2,p2>>|
|===
[[_inlinedepthschema_p2]]
*p2*
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*p2-1* +
_optional_|Description p2-1|string||
_optional_|Description p2-1|string|
|*p2-2* +
_optional_|Description p2-2|object||
_optional_|Description p2-2|object|
|===
[[_location]]
=== Location
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*Place* +
_optional_|Place|string||
_optional_|Place|string|
|===

View File

@@ -29,27 +29,27 @@ _optional_|Launch something new|<<_launchcommand_post_launchcommandrequest,Launc
[[_launchcommand_post_launchcommandrequest]]
*LaunchCommandRequest*
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*Command* +
_required_|Dummy description|<<_launchcommand_post_command,Command>>||
_required_|Dummy description|<<_launchcommand_post_command,Command>>|
|*Location* +
_optional_|Dummy description|<<_location,Location>>||
_optional_|Dummy description|<<_location,Location>>|
|*Options* +
_optional_|Dummy description|string||
_optional_|Dummy description|string|
|===
[[_launchcommand_post_command]]
*Command*
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*args* +
_optional_|Command arguments|string||
_optional_|Command arguments|string|
|*path* +
_optional_|Command path|string||
_optional_|Command path|string|
|===
@@ -85,13 +85,13 @@ _optional_|Command path|string||
[[_launchcommand_post_response_200]]
*Response 200*
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*Location* +
_optional_|<description>|<<_location,Location>>||
_optional_|<description>|<<_location,Location>>|
|*ReservationId* +
_optional_|<description>|string||
_optional_|<description>|string|
|===

View File

@@ -7,17 +7,17 @@
Information about a given HTTP mapping.
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*bean* +
_optional_|Unique name of the bean which handles the given mapping.|string||
_optional_|Unique name of the bean which handles the given mapping.|string|
|*method* +
_optional_|The signature of the method which processes requests to the given mapping.|string||
_optional_|The signature of the method which processes requests to the given mapping.|string|
|*tags* +
_optional_||<string,string> map||
_optional_||<string,string> map|
|*type* +
_optional_|The class which processes requests to the given mapping.|string||
_optional_|The class which processes requests to the given mapping.|string|
|===

View File

@@ -11,13 +11,13 @@ _Polymorphism_ : Inheritance
_Discriminator_ : collType
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*collType* +
_required_|collection type discriminator|string||
_required_|collection type discriminator|string|
|*name* +
_optional_||string||
_optional_||string|
|===
@@ -30,15 +30,15 @@ _Polymorphism_ : Inheritance
_Discriminator_ : petType
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*huntingSkill* +
_required_|The measured skill for hunting|enum (clueless, lazy, adventurous, aggressive)|lazy|
_required_|The measured skill for hunting|enum (clueless, lazy, adventurous, aggressive)|lazy
|*name* +
_optional_|conflicting property with inheriting model (issue #44)|string||
_optional_|conflicting property with inheriting model (issue #44)|string|
|*petType* +
_required_||string||
_required_||string|
|===
@@ -47,11 +47,11 @@ _required_||string||
Collection parent type without discriminator
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*name* +
_optional_||string||
_optional_||string|
|===
@@ -64,17 +64,17 @@ _Polymorphism_ : Inheritance
_Discriminator_ : dogType
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*dogType* +
_required_||string||
_required_||string|
|*name* +
_required_||string||
_required_||string|
|*packSize* +
_required_|the size of the pack the dog is from|integer(int32)|0|
_required_|the size of the pack the dog is from|integer(int32)|0
|*petType* +
_required_||string||
_required_||string|
|===
@@ -86,13 +86,13 @@ A map without discriminator
_Polymorphism_ : Composition
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*collType* +
_required_|collection type discriminator|string||
_required_|collection type discriminator|string|
|*name* +
_optional_||string||
_optional_||string|
|===
@@ -101,13 +101,13 @@ _optional_||string||
Pet parent type with discriminator
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*name* +
_required_||string||
_required_||string|
|*petType* +
_required_||string||
_required_||string|
|===

View File

@@ -1495,93 +1495,96 @@ _required_|The name that needs to be deleted|string|
[[_category]]
=== Category
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*name* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|===
[[_order]]
=== Order
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*complete* +
_optional_||boolean||true
_optional_|*Example* : `true`|boolean|
|*id* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*petId* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*quantity* +
_optional_||integer(int32)||0
_optional_|*Example* : `0`|integer(int32)|
|*shipDate* +
_optional_||string(date-time)||"string"
_optional_|*Example* : `"string"`|string(date-time)|
|*status* +
_optional_|Order Status|enum (Ordered, Cancelled)||"string"
_optional_|Order Status +
*Example* : `"string"`|enum (Ordered, Cancelled)|
|===
[[_pet]]
=== Pet
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*category* +
_optional_||<<_category,Category>>||"<<_category>>"
_optional_|*Example* : `"<<_category>>"`|<<_category,Category>>|
|*id* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*name* +
_required_||string||"doggie"
_required_|*Example* : `"doggie"`|string|
|*photoUrls* +
_required_||string array||[ "string" ]
_required_|*Example* : `[ "string" ]`|string array|
|*status* +
_optional_|pet status in the store,|enum (Dead, Alive)||"string"
_optional_|pet status in the store, +
*Example* : `"string"`|enum (Dead, Alive)|
|*tags* +
_optional_||<<_tag,Tag>> array||[ "<<_tag>>" ]
_optional_|*Example* : `[ "<<_tag>>" ]`|<<_tag,Tag>> array|
|===
[[_tag]]
=== Tag
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*name* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|===
[[_user]]
=== User
[options="header", cols=".^1,.^6,.^1,.^1,.^1"]
[options="header", cols=".^1,.^6,.^1,.^1"]
|===
|Name|Description|Schema|Default|Example
|Name|Description|Schema|Default
|*email* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*firstName* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*id* +
_optional_||integer(int64)||0
_optional_|*Example* : `0`|integer(int64)|
|*lastName* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*password* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*phone* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|*userStatus* +
_optional_|User Status|integer(int32)||0
_optional_|User Status +
*Example* : `0`|integer(int32)|
|*username* +
_optional_||string||"string"
_optional_|*Example* : `"string"`|string|
|===

View File

@@ -5,60 +5,60 @@
<a name="category"></a>
### Category
|Name|Description|Schema|Default|Example|
|---|---|---|---|---|
|**id** <br>*optional*||integer(int64)|||
|**name** <br>*optional*||string|||
|Name|Description|Schema|Default|
|---|---|---|---|
|**id** <br>*optional*||integer(int64)||
|**name** <br>*optional*||string||
<a name="order"></a>
### Order
|Name|Description|Schema|Default|Example|
|---|---|---|---|---|
|**complete** <br>*optional*||boolean|||
|**id** <br>*optional*||integer(int64)|||
|**petId** <br>*optional*||integer(int64)|||
|**quantity** <br>*optional*||integer(int32)|||
|**shipDate** <br>*optional*||string(date-time)|||
|**status** <br>*optional*|Order Status|enum (Ordered, Cancelled)|||
|Name|Description|Schema|Default|
|---|---|---|---|
|**complete** <br>*optional*||boolean||
|**id** <br>*optional*||integer(int64)||
|**petId** <br>*optional*||integer(int64)||
|**quantity** <br>*optional*||integer(int32)||
|**shipDate** <br>*optional*||string(date-time)||
|**status** <br>*optional*|Order Status|enum (Ordered, Cancelled)||
<a name="pet"></a>
### Pet
|Name|Description|Schema|Default|Example|
|---|---|---|---|---|
|**category** <br>*optional*||[Category](#category)|||
|**id** <br>*optional*||integer(int64)|||
|**name** <br>*required*||string||"doggie"|
|**photoUrls** <br>*required*||string array|||
|**status** <br>*optional*|pet status in the store,|enum (Dead, Alive)|||
|**tags** <br>*optional*||[Tag](#tag) array|||
|Name|Description|Schema|Default|
|---|---|---|---|
|**category** <br>*optional*||[Category](#category)||
|**id** <br>*optional*||integer(int64)||
|**name** <br>*required*|**Example** : `"doggie"`|string||
|**photoUrls** <br>*required*||string array||
|**status** <br>*optional*|pet status in the store,|enum (Dead, Alive)||
|**tags** <br>*optional*||[Tag](#tag) array||
<a name="tag"></a>
### Tag
|Name|Description|Schema|Default|Example|
|---|---|---|---|---|
|**id** <br>*optional*||integer(int64)|||
|**name** <br>*optional*||string|||
|Name|Description|Schema|Default|
|---|---|---|---|
|**id** <br>*optional*||integer(int64)||
|**name** <br>*optional*||string||
<a name="user"></a>
### User
|Name|Description|Schema|Default|Example|
|---|---|---|---|---|
|**email** <br>*optional*||string|||
|**firstName** <br>*optional*||string|||
|**id** <br>*optional*||integer(int64)|||
|**lastName** <br>*optional*||string|||
|**password** <br>*optional*||string|||
|**phone** <br>*optional*||string|||
|**userStatus** <br>*optional*|User Status|integer(int32)|||
|**username** <br>*optional*||string|||
|Name|Description|Schema|Default|
|---|---|---|---|
|**email** <br>*optional*||string||
|**firstName** <br>*optional*||string||
|**id** <br>*optional*||integer(int64)||
|**lastName** <br>*optional*||string||
|**password** <br>*optional*||string||
|**phone** <br>*optional*||string||
|**userStatus** <br>*optional*|User Status|integer(int32)||
|**username** <br>*optional*||string||

View File

@@ -913,6 +913,28 @@
"status": "PENDING",
"complete": true
}
},
"ComplexObject": {
"properties": {
"subObject": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 88
},
"value": {
"type": "string",
"example": "a value !"
}
},
"example": {
"id": 99,
"value" : "an example value !"
}
}
}
}
}
}