From 105ac545b350a2dd9e6a2b782d85b1dffbd49306 Mon Sep 17 00:00:00 2001 From: Hugo de Paix de Coeur Date: Wed, 6 Apr 2016 19:16:17 +0200 Subject: [PATCH] Moved Example column to description content --- .../builder/MarkupDocumentBuilder.java | 18 ++- .../asciidoc/default/definitions.adoc | 68 +++++------ .../expected/asciidoc/enums/paths.adoc | 6 +- .../asciidoc/examples/definitions.adoc | 104 ++++++++++------- .../generated_examples/definitions.adoc | 109 +++++++++++------- .../asciidoc/group_by_tags/definitions.adoc | 68 +++++------ .../asciidoc/inline_schema/definitions.adoc | 42 +++---- .../asciidoc/inline_schema/paths.adoc | 26 ++--- .../expected/asciidoc/maps/definitions.adoc | 12 +- .../asciidoc/polymorphism/definitions.adoc | 52 ++++----- .../expected/asciidoc/toFile/outputFile.adoc | 71 ++++++------ .../expected/markdown/default/definitions.md | 68 +++++------ src/test/resources/json/swagger_examples.json | 22 ++++ 13 files changed, 375 insertions(+), 291 deletions(-) diff --git a/src/main/java/io/github/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java b/src/main/java/io/github/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java index 13386fff..1dad7f58 100644 --- a/src/main/java/io/github/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java +++ b/src/main/java/io/github/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java @@ -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 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 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); } diff --git a/src/test/resources/expected/asciidoc/default/definitions.adoc b/src/test/resources/expected/asciidoc/default/definitions.adoc index fcf376ee..99856847 100644 --- a/src/test/resources/expected/asciidoc/default/definitions.adoc +++ b/src/test/resources/expected/asciidoc/default/definitions.adoc @@ -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| |=== diff --git a/src/test/resources/expected/asciidoc/enums/paths.adoc b/src/test/resources/expected/asciidoc/enums/paths.adoc index 0f37bffa..2554c865 100644 --- a/src/test/resources/expected/asciidoc/enums/paths.adoc +++ b/src/test/resources/expected/asciidoc/enums/paths.adoc @@ -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)| |=== diff --git a/src/test/resources/expected/asciidoc/examples/definitions.adoc b/src/test/resources/expected/asciidoc/examples/definitions.adoc index b0b1740d..95c51bc2 100644 --- a/src/test/resources/expected/asciidoc/examples/definitions.adoc +++ b/src/test/resources/expected/asciidoc/examples/definitions.adoc @@ -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_|| map|| +_optional_|| 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| |=== diff --git a/src/test/resources/expected/asciidoc/generated_examples/definitions.adoc b/src/test/resources/expected/asciidoc/generated_examples/definitions.adoc index 3b3d7183..800ffe93 100644 --- a/src/test/resources/expected/asciidoc/generated_examples/definitions.adoc +++ b/src/test/resources/expected/asciidoc/generated_examples/definitions.adoc @@ -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_|| map||{ +_optional_|*Example* : `{ "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| |=== diff --git a/src/test/resources/expected/asciidoc/group_by_tags/definitions.adoc b/src/test/resources/expected/asciidoc/group_by_tags/definitions.adoc index fcf376ee..99856847 100644 --- a/src/test/resources/expected/asciidoc/group_by_tags/definitions.adoc +++ b/src/test/resources/expected/asciidoc/group_by_tags/definitions.adoc @@ -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| |=== diff --git a/src/test/resources/expected/asciidoc/inline_schema/definitions.adoc b/src/test/resources/expected/asciidoc/inline_schema/definitions.adoc index cb9c8012..f72808a9 100644 --- a/src/test/resources/expected/asciidoc/inline_schema/definitions.adoc +++ b/src/test/resources/expected/asciidoc/inline_schema/definitions.adoc @@ -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| |=== diff --git a/src/test/resources/expected/asciidoc/inline_schema/paths.adoc b/src/test/resources/expected/asciidoc/inline_schema/paths.adoc index b853ffed..b6f4b014 100644 --- a/src/test/resources/expected/asciidoc/inline_schema/paths.adoc +++ b/src/test/resources/expected/asciidoc/inline_schema/paths.adoc @@ -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_||<<_location,Location>>|| +_optional_||<<_location,Location>>| |*ReservationId* + -_optional_||string|| +_optional_||string| |=== diff --git a/src/test/resources/expected/asciidoc/maps/definitions.adoc b/src/test/resources/expected/asciidoc/maps/definitions.adoc index efc0daa2..961b37b9 100644 --- a/src/test/resources/expected/asciidoc/maps/definitions.adoc +++ b/src/test/resources/expected/asciidoc/maps/definitions.adoc @@ -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_|| map|| +_optional_|| map| |*type* + -_optional_|The class which processes requests to the given mapping.|string|| +_optional_|The class which processes requests to the given mapping.|string| |=== diff --git a/src/test/resources/expected/asciidoc/polymorphism/definitions.adoc b/src/test/resources/expected/asciidoc/polymorphism/definitions.adoc index 061bfbb0..5b125c5d 100644 --- a/src/test/resources/expected/asciidoc/polymorphism/definitions.adoc +++ b/src/test/resources/expected/asciidoc/polymorphism/definitions.adoc @@ -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| |=== diff --git a/src/test/resources/expected/asciidoc/toFile/outputFile.adoc b/src/test/resources/expected/asciidoc/toFile/outputFile.adoc index d2782afd..48b39779 100644 --- a/src/test/resources/expected/asciidoc/toFile/outputFile.adoc +++ b/src/test/resources/expected/asciidoc/toFile/outputFile.adoc @@ -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| |=== diff --git a/src/test/resources/expected/markdown/default/definitions.md b/src/test/resources/expected/markdown/default/definitions.md index 93c4c651..8dd81adb 100644 --- a/src/test/resources/expected/markdown/default/definitions.md +++ b/src/test/resources/expected/markdown/default/definitions.md @@ -5,60 +5,60 @@ ### Category -|Name|Description|Schema|Default|Example| -|---|---|---|---|---| -|**id**
*optional*||integer(int64)||| -|**name**
*optional*||string||| +|Name|Description|Schema|Default| +|---|---|---|---| +|**id**
*optional*||integer(int64)|| +|**name**
*optional*||string|| ### Order -|Name|Description|Schema|Default|Example| -|---|---|---|---|---| -|**complete**
*optional*||boolean||| -|**id**
*optional*||integer(int64)||| -|**petId**
*optional*||integer(int64)||| -|**quantity**
*optional*||integer(int32)||| -|**shipDate**
*optional*||string(date-time)||| -|**status**
*optional*|Order Status|enum (Ordered, Cancelled)||| +|Name|Description|Schema|Default| +|---|---|---|---| +|**complete**
*optional*||boolean|| +|**id**
*optional*||integer(int64)|| +|**petId**
*optional*||integer(int64)|| +|**quantity**
*optional*||integer(int32)|| +|**shipDate**
*optional*||string(date-time)|| +|**status**
*optional*|Order Status|enum (Ordered, Cancelled)|| ### Pet -|Name|Description|Schema|Default|Example| -|---|---|---|---|---| -|**category**
*optional*||[Category](#category)||| -|**id**
*optional*||integer(int64)||| -|**name**
*required*||string||"doggie"| -|**photoUrls**
*required*||string array||| -|**status**
*optional*|pet status in the store,|enum (Dead, Alive)||| -|**tags**
*optional*||[Tag](#tag) array||| +|Name|Description|Schema|Default| +|---|---|---|---| +|**category**
*optional*||[Category](#category)|| +|**id**
*optional*||integer(int64)|| +|**name**
*required*|**Example** : `"doggie"`|string|| +|**photoUrls**
*required*||string array|| +|**status**
*optional*|pet status in the store,|enum (Dead, Alive)|| +|**tags**
*optional*||[Tag](#tag) array|| ### Tag -|Name|Description|Schema|Default|Example| -|---|---|---|---|---| -|**id**
*optional*||integer(int64)||| -|**name**
*optional*||string||| +|Name|Description|Schema|Default| +|---|---|---|---| +|**id**
*optional*||integer(int64)|| +|**name**
*optional*||string|| ### User -|Name|Description|Schema|Default|Example| -|---|---|---|---|---| -|**email**
*optional*||string||| -|**firstName**
*optional*||string||| -|**id**
*optional*||integer(int64)||| -|**lastName**
*optional*||string||| -|**password**
*optional*||string||| -|**phone**
*optional*||string||| -|**userStatus**
*optional*|User Status|integer(int32)||| -|**username**
*optional*||string||| +|Name|Description|Schema|Default| +|---|---|---|---| +|**email**
*optional*||string|| +|**firstName**
*optional*||string|| +|**id**
*optional*||integer(int64)|| +|**lastName**
*optional*||string|| +|**password**
*optional*||string|| +|**phone**
*optional*||string|| +|**userStatus**
*optional*|User Status|integer(int32)|| +|**username**
*optional*||string|| diff --git a/src/test/resources/json/swagger_examples.json b/src/test/resources/json/swagger_examples.json index 1bb99da5..27edd2b8 100644 --- a/src/test/resources/json/swagger_examples.json +++ b/src/test/resources/json/swagger_examples.json @@ -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 !" + } + } + } } } } \ No newline at end of file