From dce6b4183af5579d06293354dcbc1bc2e3740b93 Mon Sep 17 00:00:00 2001 From: Hugo de Paix de Coeur Date: Tue, 12 Apr 2016 17:14:58 +0200 Subject: [PATCH] update column width using values sum = 20 for better granularity on col width --- .../builder/MarkupDocumentBuilder.java | 8 +++--- .../builder/PathsDocumentBuilder.java | 26 +++++++++---------- .../builder/SecurityDocumentBuilder.java | 6 +++-- 3 files changed, 21 insertions(+), 19 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 f9d87d1d..6c332552 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 @@ -170,10 +170,10 @@ public abstract class MarkupDocumentBuilder { List inlineDefinitions = new ArrayList<>(); List> cells = new ArrayList<>(); List cols = Arrays.asList( - new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), - new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"), - new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2"), - new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1")); + new MarkupTableColumn(NAME_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"), + new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(11).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^11"), + new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"), + new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2")); if (MapUtils.isNotEmpty(properties)) { Set propertyNames = toKeySet(properties, config.getPropertyOrdering()); for (String propertyName : propertyNames) { diff --git a/src/main/java/io/github/swagger2markup/internal/document/builder/PathsDocumentBuilder.java b/src/main/java/io/github/swagger2markup/internal/document/builder/PathsDocumentBuilder.java index 2bcae606..586de097 100644 --- a/src/main/java/io/github/swagger2markup/internal/document/builder/PathsDocumentBuilder.java +++ b/src/main/java/io/github/swagger2markup/internal/document/builder/PathsDocumentBuilder.java @@ -439,10 +439,10 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder { List> cells = new ArrayList<>(); List cols = Arrays.asList( new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), - new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), - new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"), - new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2"), - new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1")); + new MarkupTableColumn(NAME_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"), + new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(10).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^10"), + new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"), + new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2")); for (Parameter parameter : parameters) { if (filterParameter(parameter)) { Type type = ParameterUtils.getType(parameter, globalContext.getSwagger().getDefinitions(), new DefinitionDocumentResolverFromOperation()); @@ -598,9 +598,9 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder { Map securityDefinitions = globalContext.getSwagger().getSecurityDefinitions(); List> cells = new ArrayList<>(); List cols = Arrays.asList( - new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), - new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), - new MarkupTableColumn(SCOPES_COLUMN).withWidthRatio(3).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3")); + new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"), + new MarkupTableColumn(NAME_COLUMN).withWidthRatio(4).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"), + new MarkupTableColumn(SCOPES_COLUMN).withWidthRatio(13).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^13")); for (Map> securityScheme : securitySchemes) { for (Map.Entry> securityEntry : securityScheme.entrySet()) { String securityKey = securityEntry.getKey(); @@ -638,14 +638,14 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder { List responseCols = Arrays.asList( new MarkupTableColumn(HTTP_CODE_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), - new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"), - new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2")); + new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(15).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^15"), + new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4")); List responseHeaderCols = Arrays.asList( - new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), - new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"), - new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2"), - new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1")); + new MarkupTableColumn(NAME_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"), + new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(11).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^11"), + new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"), + new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2")); Set responseNames = toKeySet(responses, config.getResponseOrdering()); for (String responseName : responseNames) { diff --git a/src/main/java/io/github/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java b/src/main/java/io/github/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java index 40eecae2..e67d1646 100644 --- a/src/main/java/io/github/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java +++ b/src/main/java/io/github/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java @@ -19,6 +19,7 @@ import io.github.swagger2markup.Swagger2MarkupConverter; import io.github.swagger2markup.Swagger2MarkupExtensionRegistry; import io.github.swagger2markup.internal.document.MarkupDocument; import io.github.swagger2markup.markup.builder.MarkupDocBuilder; +import io.github.swagger2markup.markup.builder.MarkupLanguage; import io.github.swagger2markup.markup.builder.MarkupTableColumn; import io.github.swagger2markup.spi.SecurityDocumentExtension; import io.swagger.models.auth.ApiKeyAuthDefinition; @@ -123,8 +124,9 @@ public class SecurityDocumentBuilder extends MarkupDocumentBuilder { } List> cells = new ArrayList<>(); - List cols = Arrays.asList(new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1), - new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(6)); + List cols = Arrays.asList( + new MarkupTableColumn(NAME_COLUMN).withWidthRatio(3).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"), + new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(17).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^17")); for (Map.Entry scope : oauth2Scheme.getScopes().entrySet()) { List content = Arrays.asList(scope.getKey(), scope.getValue()); cells.add(content);