diff --git a/src/main/java/io/github/robwin/swagger2markup/GroupBy.java b/src/main/java/io/github/swagger2markup/GroupBy.java similarity index 94% rename from src/main/java/io/github/robwin/swagger2markup/GroupBy.java rename to src/main/java/io/github/swagger2markup/GroupBy.java index 211026e9..ba098429 100644 --- a/src/main/java/io/github/robwin/swagger2markup/GroupBy.java +++ b/src/main/java/io/github/swagger2markup/GroupBy.java @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; public enum GroupBy { AS_IS, diff --git a/src/main/java/io/github/robwin/swagger2markup/Language.java b/src/main/java/io/github/swagger2markup/Language.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/Language.java rename to src/main/java/io/github/swagger2markup/Language.java index 51ef2398..bd2cb3b7 100644 --- a/src/main/java/io/github/robwin/swagger2markup/Language.java +++ b/src/main/java/io/github/swagger2markup/Language.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; import java.util.Locale; diff --git a/src/main/java/io/github/robwin/swagger2markup/OrderBy.java b/src/main/java/io/github/swagger2markup/OrderBy.java similarity index 94% rename from src/main/java/io/github/robwin/swagger2markup/OrderBy.java rename to src/main/java/io/github/swagger2markup/OrderBy.java index 11e6f07b..b2428a2b 100644 --- a/src/main/java/io/github/robwin/swagger2markup/OrderBy.java +++ b/src/main/java/io/github/swagger2markup/OrderBy.java @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; public enum OrderBy { AS_IS, diff --git a/src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConfig.java b/src/main/java/io/github/swagger2markup/Swagger2MarkupConfig.java similarity index 96% rename from src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConfig.java rename to src/main/java/io/github/swagger2markup/Swagger2MarkupConfig.java index 4e4898ae..5e4f5742 100644 --- a/src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConfig.java +++ b/src/main/java/io/github/swagger2markup/Swagger2MarkupConfig.java @@ -13,14 +13,14 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; import com.google.common.base.Function; import com.google.common.collect.Ordering; import io.github.robwin.markup.builder.LineSeparator; import io.github.robwin.markup.builder.MarkupLanguage; -import io.github.robwin.swagger2markup.internal.model.PathOperation; -import io.github.robwin.swagger2markup.internal.utils.IOUtils; +import io.github.swagger2markup.internal.model.PathOperation; +import io.github.swagger2markup.utils.IOUtils; import io.swagger.models.HttpMethod; import io.swagger.models.parameters.Parameter; import org.apache.commons.lang3.StringUtils; @@ -93,8 +93,8 @@ public class Swagger2MarkupConfig { } /** - * Automatically set default path for external content files based on specified {@code swaggerLocation}.
- * If {@code swaggerLocation} is null, default path can't be set and features are disabled.
+ * Automatically set default path for external content files based on specified {@code swaggerLocation}.
+ * If {@code swaggerLocation} is null, default path can't be set and features are disabled.
* Paths have to be explicitly set when swaggerLocation.scheme != 'file' to limit the number of URL requests. * * @param swaggerLocation base path to set default paths @@ -428,7 +428,7 @@ public class Swagger2MarkupConfig { } /** - * Include hand-written descriptions into the Paths document.
+ * Include hand-written descriptions into the Paths document.
* Use default URI. * * @return this builder @@ -463,7 +463,7 @@ public class Swagger2MarkupConfig { } /** - * Include hand-written descriptions into the Definitions document.
+ * Include hand-written descriptions into the Definitions document.
* Use default URI. * * @return this builder @@ -532,8 +532,8 @@ public class Swagger2MarkupConfig { } /** - * Specifies tag ordering.
- * By default tag ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.
+ * Specifies tag ordering.
+ * By default tag ordering == {@link io.github.swagger2markup.OrderBy#NATURAL}.
* Use {@link #withTagOrdering(Comparator)} to set a custom ordering. * * @param orderBy tag ordering @@ -560,8 +560,8 @@ public class Swagger2MarkupConfig { } /** - * Specifies operation ordering.
- * By default operation ordering == {@link io.github.robwin.swagger2markup.OrderBy#AS_IS}.
+ * Specifies operation ordering.
+ * By default operation ordering == {@link io.github.swagger2markup.OrderBy#AS_IS}.
* Use {@link #withOperationOrdering(Comparator)} to set a custom ordering. * * @param orderBy operation ordering @@ -588,8 +588,8 @@ public class Swagger2MarkupConfig { } /** - * Specifies definition ordering.
- * By default definition ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.
+ * Specifies definition ordering.
+ * By default definition ordering == {@link io.github.swagger2markup.OrderBy#NATURAL}.
* Use {@link #withDefinitionOrdering(Comparator)} to set a custom ordering. * * @param orderBy definition ordering @@ -616,8 +616,8 @@ public class Swagger2MarkupConfig { } /** - * Specifies parameter ordering.
- * By default parameter ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.
+ * Specifies parameter ordering.
+ * By default parameter ordering == {@link OrderBy#NATURAL}.
* Use {@link #withParameterOrdering(Comparator)} to set a custom ordering. * * @param orderBy parameter ordering @@ -645,8 +645,8 @@ public class Swagger2MarkupConfig { } /** - * Specifies property ordering.
- * By default property ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.
+ * Specifies property ordering.
+ * By default property ordering == {@link io.github.swagger2markup.OrderBy#NATURAL}.
* Use {@link #withPropertyOrdering(Comparator)} to set a custom ordering. * * @param orderBy property ordering @@ -674,8 +674,8 @@ public class Swagger2MarkupConfig { } /** - * Specifies response ordering.
- * By default response ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.
+ * Specifies response ordering.
+ * By default response ordering == {@link io.github.swagger2markup.OrderBy#NATURAL}.
* Use {@link #withResponseOrdering(Comparator)} to set a custom ordering. * * @param orderBy response ordering diff --git a/src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConverter.java b/src/main/java/io/github/swagger2markup/Swagger2MarkupConverter.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConverter.java rename to src/main/java/io/github/swagger2markup/Swagger2MarkupConverter.java index 722bdba8..ac11d620 100644 --- a/src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConverter.java +++ b/src/main/java/io/github/swagger2markup/Swagger2MarkupConverter.java @@ -13,15 +13,15 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; import com.google.common.annotations.VisibleForTesting; -import io.github.robwin.swagger2markup.internal.document.builder.DefinitionsDocumentBuilder; -import io.github.robwin.swagger2markup.internal.document.builder.OverviewDocumentBuilder; -import io.github.robwin.swagger2markup.internal.document.builder.PathsDocumentBuilder; -import io.github.robwin.swagger2markup.internal.document.builder.SecurityDocumentBuilder; -import io.github.robwin.swagger2markup.spi.Extension; -import io.github.robwin.swagger2markup.spi.SwaggerModelExtension; +import io.github.swagger2markup.internal.document.builder.DefinitionsDocumentBuilder; +import io.github.swagger2markup.internal.document.builder.OverviewDocumentBuilder; +import io.github.swagger2markup.internal.document.builder.PathsDocumentBuilder; +import io.github.swagger2markup.internal.document.builder.SecurityDocumentBuilder; +import io.github.swagger2markup.spi.Extension; +import io.github.swagger2markup.spi.SwaggerModelExtension; import io.swagger.models.Swagger; import io.swagger.parser.SwaggerParser; import org.apache.commons.io.IOUtils; diff --git a/src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupExtensionRegistry.java b/src/main/java/io/github/swagger2markup/Swagger2MarkupExtensionRegistry.java similarity index 80% rename from src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupExtensionRegistry.java rename to src/main/java/io/github/swagger2markup/Swagger2MarkupExtensionRegistry.java index 47c40e5d..44ff861a 100644 --- a/src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupExtensionRegistry.java +++ b/src/main/java/io/github/swagger2markup/Swagger2MarkupExtensionRegistry.java @@ -14,15 +14,11 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; import com.google.common.collect.Multimap; import com.google.common.collect.MultimapBuilder; -import io.github.robwin.swagger2markup.internal.extensions.DynamicDefinitionsDocumentExtension; -import io.github.robwin.swagger2markup.internal.extensions.DynamicPathsDocumentExtension; -import io.github.robwin.swagger2markup.internal.extensions.DynamicOverviewDocumentExtension; -import io.github.robwin.swagger2markup.internal.extensions.DynamicSecurityDocumentExtension; -import io.github.robwin.swagger2markup.spi.*; +import io.github.swagger2markup.spi.*; import java.util.ArrayList; import java.util.Arrays; @@ -59,12 +55,6 @@ public class Swagger2MarkupExtensionRegistry { Builder(boolean useDefaults) { extensions = MultimapBuilder.hashKeys().arrayListValues().build(); - if (useDefaults) { - withExtension(new DynamicOverviewDocumentExtension()); - withExtension(new DynamicSecurityDocumentExtension()); - withExtension(new DynamicPathsDocumentExtension()); - withExtension(new DynamicDefinitionsDocumentExtension()); - } } public Swagger2MarkupExtensionRegistry build() { diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/document/MarkupDocument.java b/src/main/java/io/github/swagger2markup/internal/document/MarkupDocument.java similarity index 96% rename from src/main/java/io/github/robwin/swagger2markup/internal/document/MarkupDocument.java rename to src/main/java/io/github/swagger2markup/internal/document/MarkupDocument.java index bb9a9a99..6d5ec10c 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/document/MarkupDocument.java +++ b/src/main/java/io/github/swagger2markup/internal/document/MarkupDocument.java @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.document; +package io.github.swagger2markup.internal.document; import io.github.robwin.markup.builder.MarkupDocBuilder; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/DefinitionsDocumentBuilder.java b/src/main/java/io/github/swagger2markup/internal/document/builder/DefinitionsDocumentBuilder.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/internal/document/builder/DefinitionsDocumentBuilder.java rename to src/main/java/io/github/swagger2markup/internal/document/builder/DefinitionsDocumentBuilder.java index ce59abc4..c2d37f31 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/DefinitionsDocumentBuilder.java +++ b/src/main/java/io/github/swagger2markup/internal/document/builder/DefinitionsDocumentBuilder.java @@ -13,16 +13,16 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.document.builder; +package io.github.swagger2markup.internal.document.builder; import com.google.common.base.Optional; import com.google.common.collect.ImmutableMap; import io.github.robwin.markup.builder.MarkupDocBuilder; -import io.github.robwin.swagger2markup.Swagger2MarkupConverter; -import io.github.robwin.swagger2markup.internal.document.MarkupDocument; -import io.github.robwin.swagger2markup.spi.DefinitionsDocumentExtension; -import io.github.robwin.swagger2markup.internal.type.ObjectType; -import io.github.robwin.swagger2markup.internal.type.Type; +import io.github.swagger2markup.Swagger2MarkupConverter; +import io.github.swagger2markup.internal.document.MarkupDocument; +import io.github.swagger2markup.spi.DefinitionsDocumentExtension; +import io.github.swagger2markup.internal.type.ObjectType; +import io.github.swagger2markup.internal.type.Type; import io.swagger.models.ComposedModel; import io.swagger.models.Model; import io.swagger.models.RefModel; @@ -42,11 +42,11 @@ import java.nio.charset.StandardCharsets; import java.nio.file.Path; import java.util.*; -import static io.github.robwin.swagger2markup.internal.utils.IOUtils.normalizeName; -import static io.github.robwin.swagger2markup.spi.DefinitionsDocumentExtension.*; +import static io.github.swagger2markup.utils.IOUtils.normalizeName; +import static io.github.swagger2markup.spi.DefinitionsDocumentExtension.*; import static org.apache.commons.lang3.StringUtils.defaultString; import static org.apache.commons.lang3.StringUtils.isNotBlank; -import static io.github.robwin.swagger2markup.internal.utils.MapUtils.toKeySet; +import static io.github.swagger2markup.internal.utils.MapUtils.toKeySet; /** * @author Robert Winkler @@ -328,7 +328,7 @@ public class DefinitionsDocumentBuilder extends MarkupDocumentBuilder { for (String fileNameExtension : config.getMarkupLanguage().getFileNameExtensions()) { URI contentUri = config.getDefinitionDescriptionsUri().resolve(descriptionFolder).resolve(descriptionFileName + fileNameExtension); - try (Reader reader = io.github.robwin.swagger2markup.internal.utils.IOUtils.uriReader(contentUri)) { + try (Reader reader = io.github.swagger2markup.utils.IOUtils.uriReader(contentUri)) { if (logger.isInfoEnabled()) { logger.info("Definition description content processed {}", contentUri); } diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java b/src/main/java/io/github/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java similarity index 91% rename from src/main/java/io/github/robwin/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java rename to src/main/java/io/github/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java index bdb4a80a..ec5315f2 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java +++ b/src/main/java/io/github/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java @@ -13,21 +13,21 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.document.builder; +package io.github.swagger2markup.internal.document.builder; import io.github.robwin.markup.builder.MarkupDocBuilder; import io.github.robwin.markup.builder.MarkupDocBuilders; import io.github.robwin.markup.builder.MarkupLanguage; import io.github.robwin.markup.builder.MarkupTableColumn; -import io.github.robwin.swagger2markup.Swagger2MarkupConfig; -import io.github.robwin.swagger2markup.Swagger2MarkupConverter; -import io.github.robwin.swagger2markup.internal.document.MarkupDocument; -import io.github.robwin.swagger2markup.internal.type.DefinitionDocumentResolver; -import io.github.robwin.swagger2markup.internal.type.ObjectType; -import io.github.robwin.swagger2markup.internal.type.RefType; -import io.github.robwin.swagger2markup.internal.type.Type; -import io.github.robwin.swagger2markup.internal.utils.IOUtils; -import io.github.robwin.swagger2markup.internal.utils.PropertyUtils; +import io.github.swagger2markup.Swagger2MarkupConfig; +import io.github.swagger2markup.Swagger2MarkupConverter; +import io.github.swagger2markup.internal.document.MarkupDocument; +import io.github.swagger2markup.internal.type.DefinitionDocumentResolver; +import io.github.swagger2markup.internal.type.ObjectType; +import io.github.swagger2markup.internal.type.RefType; +import io.github.swagger2markup.internal.type.Type; +import io.github.swagger2markup.utils.IOUtils; +import io.github.swagger2markup.internal.utils.PropertyUtils; import io.swagger.models.properties.Property; import io.swagger.util.Json; import org.apache.commons.collections4.MapUtils; @@ -39,7 +39,7 @@ import java.io.IOException; import java.nio.file.Path; import java.util.*; -import static io.github.robwin.swagger2markup.internal.utils.MapUtils.toKeySet; +import static io.github.swagger2markup.internal.utils.MapUtils.toKeySet; import static org.apache.commons.lang3.StringUtils.defaultString; import static org.apache.commons.lang3.StringUtils.isNotBlank; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/OverviewDocumentBuilder.java b/src/main/java/io/github/swagger2markup/internal/document/builder/OverviewDocumentBuilder.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/internal/document/builder/OverviewDocumentBuilder.java rename to src/main/java/io/github/swagger2markup/internal/document/builder/OverviewDocumentBuilder.java index a808fb94..6d670776 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/OverviewDocumentBuilder.java +++ b/src/main/java/io/github/swagger2markup/internal/document/builder/OverviewDocumentBuilder.java @@ -13,11 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.document.builder; +package io.github.swagger2markup.internal.document.builder; -import io.github.robwin.swagger2markup.Swagger2MarkupConverter; -import io.github.robwin.swagger2markup.internal.document.MarkupDocument; -import io.github.robwin.swagger2markup.spi.OverviewDocumentExtension; +import io.github.swagger2markup.Swagger2MarkupConverter; +import io.github.swagger2markup.internal.document.MarkupDocument; +import io.github.swagger2markup.spi.OverviewDocumentExtension; import io.swagger.models.*; import java.nio.file.Path; @@ -25,7 +25,7 @@ import java.util.ArrayList; import java.util.List; import java.util.ResourceBundle; -import static io.github.robwin.swagger2markup.spi.OverviewDocumentExtension.*; +import static io.github.swagger2markup.spi.OverviewDocumentExtension.*; import static org.apache.commons.collections4.CollectionUtils.isNotEmpty; import static org.apache.commons.lang3.StringUtils.*; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/PathsDocumentBuilder.java b/src/main/java/io/github/swagger2markup/internal/document/builder/PathsDocumentBuilder.java similarity index 96% rename from src/main/java/io/github/robwin/swagger2markup/internal/document/builder/PathsDocumentBuilder.java rename to src/main/java/io/github/swagger2markup/internal/document/builder/PathsDocumentBuilder.java index 2b5337ee..2d66f137 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/PathsDocumentBuilder.java +++ b/src/main/java/io/github/swagger2markup/internal/document/builder/PathsDocumentBuilder.java @@ -13,21 +13,24 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.document.builder; +package io.github.swagger2markup.internal.document.builder; import com.google.common.base.Joiner; import com.google.common.base.Optional; import com.google.common.collect.Multimap; import io.github.robwin.markup.builder.*; -import io.github.robwin.swagger2markup.GroupBy; -import io.github.robwin.swagger2markup.Swagger2MarkupConverter; -import io.github.robwin.swagger2markup.internal.document.MarkupDocument; -import io.github.robwin.swagger2markup.internal.model.PathOperation; -import io.github.robwin.swagger2markup.internal.type.ObjectType; -import io.github.robwin.swagger2markup.internal.type.RefType; -import io.github.robwin.swagger2markup.internal.type.Type; -import io.github.robwin.swagger2markup.internal.utils.*; -import io.github.robwin.swagger2markup.spi.PathsDocumentExtension; +import io.github.swagger2markup.GroupBy; +import io.github.swagger2markup.Swagger2MarkupConverter; +import io.github.swagger2markup.internal.document.MarkupDocument; +import io.github.swagger2markup.internal.model.PathOperation; +import io.github.swagger2markup.internal.type.ObjectType; +import io.github.swagger2markup.internal.type.RefType; +import io.github.swagger2markup.internal.type.Type; +import io.github.swagger2markup.internal.utils.ExamplesUtil; +import io.github.swagger2markup.internal.utils.ParameterUtils; +import io.github.swagger2markup.internal.utils.PropertyUtils; +import io.github.swagger2markup.internal.utils.TagUtils; +import io.github.swagger2markup.spi.PathsDocumentExtension; import io.swagger.models.*; import io.swagger.models.auth.SecuritySchemeDefinition; import io.swagger.models.parameters.Parameter; @@ -47,12 +50,13 @@ import java.net.URI; import java.nio.charset.StandardCharsets; import java.util.*; -import static io.github.robwin.swagger2markup.internal.utils.IOUtils.normalizeName; -import static io.github.robwin.swagger2markup.internal.utils.ListUtils.*; -import static io.github.robwin.swagger2markup.internal.utils.MapUtils.toKeySet; -import static io.github.robwin.swagger2markup.internal.utils.TagUtils.convertTagsListToMap; -import static io.github.robwin.swagger2markup.internal.utils.TagUtils.getTagDescription; -import static io.github.robwin.swagger2markup.spi.PathsDocumentExtension.*; +import static io.github.swagger2markup.utils.IOUtils.normalizeName; +import static io.github.swagger2markup.internal.utils.ListUtils.toSet; +import static io.github.swagger2markup.internal.utils.MapUtils.toKeySet; +import static io.github.swagger2markup.internal.utils.TagUtils.convertTagsListToMap; +import static io.github.swagger2markup.internal.utils.TagUtils.getTagDescription; +import static io.github.swagger2markup.spi.PathsDocumentExtension.Context; +import static io.github.swagger2markup.spi.PathsDocumentExtension.Position; import static org.apache.commons.lang3.StringUtils.defaultString; import static org.apache.commons.lang3.StringUtils.isNotBlank; @@ -675,7 +679,7 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder { for (String fileNameExtension : config.getMarkupLanguage().getFileNameExtensions()) { URI contentUri = config.getOperationDescriptionsUri().resolve(descriptionFolder).resolve(descriptionFileName + fileNameExtension); - try (Reader reader = io.github.robwin.swagger2markup.internal.utils.IOUtils.uriReader(contentUri)) { + try (Reader reader = io.github.swagger2markup.utils.IOUtils.uriReader(contentUri)) { if (logger.isInfoEnabled()) { logger.info("Operation description content processed {}", contentUri); } @@ -804,7 +808,7 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder { String defaultResolver = super.apply(definitionName); if (defaultResolver != null && config.isSeparatedOperationsEnabled()) - return defaultString(config.getInterDocumentCrossReferencesPrefix()) + new File("..", defaultResolver).getPath(); + return defaultString(config.getInterDocumentCrossReferencesPrefix()) + new File("src/main", defaultResolver).getPath(); else return defaultResolver; } diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java b/src/main/java/io/github/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java similarity index 93% rename from src/main/java/io/github/robwin/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java rename to src/main/java/io/github/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java index cded2568..fd31ddb6 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java +++ b/src/main/java/io/github/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java @@ -13,13 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.document.builder; +package io.github.swagger2markup.internal.document.builder; import io.github.robwin.markup.builder.MarkupDocBuilder; import io.github.robwin.markup.builder.MarkupTableColumn; -import io.github.robwin.swagger2markup.Swagger2MarkupConverter; -import io.github.robwin.swagger2markup.internal.document.MarkupDocument; -import io.github.robwin.swagger2markup.spi.SecurityDocumentExtension; +import io.github.swagger2markup.Swagger2MarkupConverter; +import io.github.swagger2markup.internal.document.MarkupDocument; +import io.github.swagger2markup.spi.SecurityDocumentExtension; import io.swagger.models.auth.ApiKeyAuthDefinition; import io.swagger.models.auth.OAuth2Definition; import io.swagger.models.auth.SecuritySchemeDefinition; @@ -28,8 +28,8 @@ import org.apache.commons.collections4.MapUtils; import java.nio.file.Path; import java.util.*; -import static io.github.robwin.swagger2markup.spi.SecurityDocumentExtension.Context; -import static io.github.robwin.swagger2markup.spi.SecurityDocumentExtension.Position; +import static io.github.swagger2markup.spi.SecurityDocumentExtension.Context; +import static io.github.swagger2markup.spi.SecurityDocumentExtension.Position; import static org.apache.commons.lang3.StringUtils.isNotBlank; /** diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/model/PathOperation.java b/src/main/java/io/github/swagger2markup/internal/model/PathOperation.java similarity index 94% rename from src/main/java/io/github/robwin/swagger2markup/internal/model/PathOperation.java rename to src/main/java/io/github/swagger2markup/internal/model/PathOperation.java index 84af1bd0..c644bfd8 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/model/PathOperation.java +++ b/src/main/java/io/github/swagger2markup/internal/model/PathOperation.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.model; +package io.github.swagger2markup.internal.model; import io.swagger.models.HttpMethod; import io.swagger.models.Operation; @@ -54,7 +54,7 @@ public class PathOperation { } /** - * Returns an unique id for the operation.
+ * Returns an unique id for the operation.
* Use {@code }, then {@code lowercase()} if operation id is not set. * * @return operation unique id diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/type/ArrayType.java b/src/main/java/io/github/swagger2markup/internal/type/ArrayType.java similarity index 96% rename from src/main/java/io/github/robwin/swagger2markup/internal/type/ArrayType.java rename to src/main/java/io/github/swagger2markup/internal/type/ArrayType.java index d1225d52..4a157085 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/type/ArrayType.java +++ b/src/main/java/io/github/swagger2markup/internal/type/ArrayType.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.type; +package io.github.swagger2markup.internal.type; import io.github.robwin.markup.builder.MarkupDocBuilder; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/type/BasicType.java b/src/main/java/io/github/swagger2markup/internal/type/BasicType.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/internal/type/BasicType.java rename to src/main/java/io/github/swagger2markup/internal/type/BasicType.java index d0841095..84cc032a 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/type/BasicType.java +++ b/src/main/java/io/github/swagger2markup/internal/type/BasicType.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.type; +package io.github.swagger2markup.internal.type; import io.github.robwin.markup.builder.MarkupDocBuilder; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/type/DefinitionDocumentResolver.java b/src/main/java/io/github/swagger2markup/internal/type/DefinitionDocumentResolver.java similarity index 93% rename from src/main/java/io/github/robwin/swagger2markup/internal/type/DefinitionDocumentResolver.java rename to src/main/java/io/github/swagger2markup/internal/type/DefinitionDocumentResolver.java index 418dcd03..83606f8e 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/type/DefinitionDocumentResolver.java +++ b/src/main/java/io/github/swagger2markup/internal/type/DefinitionDocumentResolver.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.type; +package io.github.swagger2markup.internal.type; import com.google.common.base.Function; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/type/EnumType.java b/src/main/java/io/github/swagger2markup/internal/type/EnumType.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/internal/type/EnumType.java rename to src/main/java/io/github/swagger2markup/internal/type/EnumType.java index 5b46f023..43272cd7 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/type/EnumType.java +++ b/src/main/java/io/github/swagger2markup/internal/type/EnumType.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.type; +package io.github.swagger2markup.internal.type; import io.github.robwin.markup.builder.MarkupDocBuilder; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/type/ObjectType.java b/src/main/java/io/github/swagger2markup/internal/type/ObjectType.java similarity index 96% rename from src/main/java/io/github/robwin/swagger2markup/internal/type/ObjectType.java rename to src/main/java/io/github/swagger2markup/internal/type/ObjectType.java index 051001bc..525c2d76 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/type/ObjectType.java +++ b/src/main/java/io/github/swagger2markup/internal/type/ObjectType.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.type; +package io.github.swagger2markup.internal.type; import io.github.robwin.markup.builder.MarkupDocBuilder; import io.swagger.models.properties.Property; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/type/RefType.java b/src/main/java/io/github/swagger2markup/internal/type/RefType.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/internal/type/RefType.java rename to src/main/java/io/github/swagger2markup/internal/type/RefType.java index fb9edba8..69c63d56 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/type/RefType.java +++ b/src/main/java/io/github/swagger2markup/internal/type/RefType.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.type; +package io.github.swagger2markup.internal.type; import io.github.robwin.markup.builder.MarkupDocBuilder; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/type/Type.java b/src/main/java/io/github/swagger2markup/internal/type/Type.java similarity index 96% rename from src/main/java/io/github/robwin/swagger2markup/internal/type/Type.java rename to src/main/java/io/github/swagger2markup/internal/type/Type.java index e379c5c6..f0cd4333 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/type/Type.java +++ b/src/main/java/io/github/swagger2markup/internal/type/Type.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.type; +package io.github.swagger2markup.internal.type; import io.github.robwin.markup.builder.MarkupDocBuilder; import org.apache.commons.lang3.Validate; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/utils/ExamplesUtil.java b/src/main/java/io/github/swagger2markup/internal/utils/ExamplesUtil.java similarity index 93% rename from src/main/java/io/github/robwin/swagger2markup/internal/utils/ExamplesUtil.java rename to src/main/java/io/github/swagger2markup/internal/utils/ExamplesUtil.java index 36a2775b..2fec4470 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/utils/ExamplesUtil.java +++ b/src/main/java/io/github/swagger2markup/internal/utils/ExamplesUtil.java @@ -14,10 +14,10 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.utils; +package io.github.swagger2markup.internal.utils; import io.github.robwin.markup.builder.MarkupDocBuilder; -import io.github.robwin.swagger2markup.internal.model.PathOperation; +import io.github.swagger2markup.internal.model.PathOperation; import io.swagger.models.*; import io.swagger.models.parameters.*; import io.swagger.models.properties.ArrayProperty; @@ -39,7 +39,10 @@ public class ExamplesUtil { /** * Generates a Map of response examples * + * @param generateMissingExamples specifies the missing examples should be generated * @param operation the Swagger Operation + * @param definitions the map of definitions + * @param markupDocBuilder the markup builder * @return map containing response examples. */ public static Map generateResponseExampleMap(boolean generateMissingExamples, Operation operation, Map definitions, MarkupDocBuilder markupDocBuilder) { @@ -74,7 +77,10 @@ public class ExamplesUtil { /** * Generates examples for request * + * @param generateMissingExamples specifies the missing examples should be generated * @param pathOperation the Swagger Operation + * @param definitions the map of definitions + * @param markupDocBuilder the markup builder * @return an Optional with the example content */ public static Map generateRequestExampleMap(boolean generateMissingExamples, PathOperation pathOperation, Map definitions, MarkupDocBuilder markupDocBuilder) { @@ -157,7 +163,10 @@ public class ExamplesUtil { /** * Generates an example object from a simple reference * + * @param generateMissingExamples specifies the missing examples should be generated * @param simpleRef the simple reference string + * @param definitions the map of definitions + * @param markupDocBuilder the markup builder * @return returns an Object or Map of examples */ public static Object generateExampleForRefModel(boolean generateMissingExamples, String simpleRef, Map definitions, MarkupDocBuilder markupDocBuilder) { @@ -205,7 +214,10 @@ public class ExamplesUtil { * Generates a map of examples from a map of properties. If defined examples are found, those are used. Otherwise, * examples are generated from the type. * - * @param properties map of properties + * @param properties the map of properties + * @param definitions the map of definitions + * @param markupDocBuilder the markup builder + * * @return a Map of examples */ public static Map exampleMapForProperties(Map properties, Map definitions, MarkupDocBuilder markupDocBuilder) { @@ -266,6 +278,8 @@ public class ExamplesUtil { * Generates examples from an ArrayProperty * * @param value ArrayProperty + * @param definitions map of definitions + * @param markupDocBuilder the markup builder * @return array of Object */ public static Object[] generateExampleForArrayProperty(ArrayProperty value, Map definitions, MarkupDocBuilder markupDocBuilder) { diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/utils/ListUtils.java b/src/main/java/io/github/swagger2markup/internal/utils/ListUtils.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/internal/utils/ListUtils.java rename to src/main/java/io/github/swagger2markup/internal/utils/ListUtils.java index 63556118..8643a66c 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/utils/ListUtils.java +++ b/src/main/java/io/github/swagger2markup/internal/utils/ListUtils.java @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.utils; +package io.github.swagger2markup.internal.utils; import java.util.*; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/utils/MapUtils.java b/src/main/java/io/github/swagger2markup/internal/utils/MapUtils.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/internal/utils/MapUtils.java rename to src/main/java/io/github/swagger2markup/internal/utils/MapUtils.java index e18543bf..8e9d2c25 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/utils/MapUtils.java +++ b/src/main/java/io/github/swagger2markup/internal/utils/MapUtils.java @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.utils; +package io.github.swagger2markup.internal.utils; import java.util.*; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/utils/ModelUtils.java b/src/main/java/io/github/swagger2markup/internal/utils/ModelUtils.java similarity index 83% rename from src/main/java/io/github/robwin/swagger2markup/internal/utils/ModelUtils.java rename to src/main/java/io/github/swagger2markup/internal/utils/ModelUtils.java index 12ea82f6..d41bc99a 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/utils/ModelUtils.java +++ b/src/main/java/io/github/swagger2markup/internal/utils/ModelUtils.java @@ -13,13 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.utils; +package io.github.swagger2markup.internal.utils; import com.google.common.base.Function; -import io.github.robwin.swagger2markup.internal.type.ArrayType; -import io.github.robwin.swagger2markup.internal.type.ObjectType; -import io.github.robwin.swagger2markup.internal.type.RefType; -import io.github.robwin.swagger2markup.internal.type.Type; +import io.github.swagger2markup.internal.type.ArrayType; +import io.github.swagger2markup.internal.type.ObjectType; +import io.github.swagger2markup.internal.type.RefType; +import io.github.swagger2markup.internal.type.Type; import io.swagger.models.ArrayModel; import io.swagger.models.Model; import io.swagger.models.ModelImpl; @@ -32,6 +32,7 @@ public final class ModelUtils { * Retrieves the type of a model, or otherwise null * * @param model the model + * @param definitionDocumentResolver the definition document resolver * @return the type of the model, or otherwise null */ public static Type getType(Model model, Function definitionDocumentResolver) { diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/utils/ParameterUtils.java b/src/main/java/io/github/swagger2markup/internal/utils/ParameterUtils.java similarity index 96% rename from src/main/java/io/github/robwin/swagger2markup/internal/utils/ParameterUtils.java rename to src/main/java/io/github/swagger2markup/internal/utils/ParameterUtils.java index 89ddfab2..49e1bb98 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/utils/ParameterUtils.java +++ b/src/main/java/io/github/swagger2markup/internal/utils/ParameterUtils.java @@ -13,11 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.utils; +package io.github.swagger2markup.internal.utils; import com.google.common.base.Function; import io.github.robwin.markup.builder.MarkupDocBuilder; -import io.github.robwin.swagger2markup.internal.type.*; +import io.github.swagger2markup.internal.type.*; import io.swagger.models.Model; import io.swagger.models.parameters.AbstractSerializableParameter; import io.swagger.models.parameters.BodyParameter; @@ -37,6 +37,7 @@ public final class ParameterUtils { * Retrieves the type of a parameter, or otherwise null * * @param parameter the parameter + * @param definitionDocumentResolver the defintion document resolver * @return the type of the parameter, or otherwise null */ public static Type getType(Parameter parameter, Function definitionDocumentResolver){ diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/utils/PropertyUtils.java b/src/main/java/io/github/swagger2markup/internal/utils/PropertyUtils.java similarity index 96% rename from src/main/java/io/github/robwin/swagger2markup/internal/utils/PropertyUtils.java rename to src/main/java/io/github/swagger2markup/internal/utils/PropertyUtils.java index 0518c058..c0437b02 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/utils/PropertyUtils.java +++ b/src/main/java/io/github/swagger2markup/internal/utils/PropertyUtils.java @@ -13,11 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.utils; +package io.github.swagger2markup.internal.utils; import com.google.common.base.Function; import io.github.robwin.markup.builder.MarkupDocBuilder; -import io.github.robwin.swagger2markup.internal.type.*; +import io.github.swagger2markup.internal.type.*; import io.swagger.models.properties.*; import io.swagger.models.refs.RefFormat; import org.apache.commons.collections4.CollectionUtils; @@ -33,6 +33,7 @@ public final class PropertyUtils { * Retrieves the type and format of a property. * * @param property the property + * @param definitionDocumentResolver the definition document resolver * @return the type of the property */ public static Type getType(Property property, Function definitionDocumentResolver) { @@ -105,6 +106,7 @@ public final class PropertyUtils { /** * Return example display string for the given {@code property}. * + * @param generateMissingExamples specifies if missing examples should be generated * @param property property * @param markupDocBuilder doc builder * @return property example display string diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/utils/TagUtils.java b/src/main/java/io/github/swagger2markup/internal/utils/TagUtils.java similarity index 96% rename from src/main/java/io/github/robwin/swagger2markup/internal/utils/TagUtils.java rename to src/main/java/io/github/swagger2markup/internal/utils/TagUtils.java index 5823642a..7e244d65 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/utils/TagUtils.java +++ b/src/main/java/io/github/swagger2markup/internal/utils/TagUtils.java @@ -13,13 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.utils; +package io.github.swagger2markup.internal.utils; import com.google.common.base.Optional; import com.google.common.collect.Multimap; import com.google.common.collect.MultimapBuilder; import com.google.common.collect.Ordering; -import io.github.robwin.swagger2markup.internal.model.PathOperation; +import io.github.swagger2markup.internal.model.PathOperation; import io.swagger.models.Tag; import org.apache.commons.lang3.Validate; import org.slf4j.Logger; diff --git a/src/main/java/io/github/robwin/swagger2markup/spi/AbstractExtension.java b/src/main/java/io/github/swagger2markup/spi/AbstractExtension.java similarity index 92% rename from src/main/java/io/github/robwin/swagger2markup/spi/AbstractExtension.java rename to src/main/java/io/github/swagger2markup/spi/AbstractExtension.java index 6a5938b5..5096350d 100644 --- a/src/main/java/io/github/robwin/swagger2markup/spi/AbstractExtension.java +++ b/src/main/java/io/github/swagger2markup/spi/AbstractExtension.java @@ -14,9 +14,9 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; -import io.github.robwin.swagger2markup.Swagger2MarkupConverter; +import io.github.swagger2markup.Swagger2MarkupConverter; /** * An abstract extension which must be extended by an extension diff --git a/src/main/java/io/github/robwin/swagger2markup/spi/ContentContext.java b/src/main/java/io/github/swagger2markup/spi/ContentContext.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/spi/ContentContext.java rename to src/main/java/io/github/swagger2markup/spi/ContentContext.java index 1f12b2ac..cb8dd46c 100644 --- a/src/main/java/io/github/robwin/swagger2markup/spi/ContentContext.java +++ b/src/main/java/io/github/swagger2markup/spi/ContentContext.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; import io.github.robwin.markup.builder.MarkupDocBuilder; diff --git a/src/main/java/io/github/robwin/swagger2markup/spi/DefinitionsDocumentExtension.java b/src/main/java/io/github/swagger2markup/spi/DefinitionsDocumentExtension.java similarity index 98% rename from src/main/java/io/github/robwin/swagger2markup/spi/DefinitionsDocumentExtension.java rename to src/main/java/io/github/swagger2markup/spi/DefinitionsDocumentExtension.java index d553ef76..9bdcb649 100644 --- a/src/main/java/io/github/robwin/swagger2markup/spi/DefinitionsDocumentExtension.java +++ b/src/main/java/io/github/swagger2markup/spi/DefinitionsDocumentExtension.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; import org.apache.commons.lang3.Validate; diff --git a/src/main/java/io/github/robwin/swagger2markup/spi/Extension.java b/src/main/java/io/github/swagger2markup/spi/Extension.java similarity index 89% rename from src/main/java/io/github/robwin/swagger2markup/spi/Extension.java rename to src/main/java/io/github/swagger2markup/spi/Extension.java index f30df7fb..3693abc1 100644 --- a/src/main/java/io/github/robwin/swagger2markup/spi/Extension.java +++ b/src/main/java/io/github/swagger2markup/spi/Extension.java @@ -14,9 +14,9 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; -import io.github.robwin.swagger2markup.Swagger2MarkupConverter; +import io.github.swagger2markup.Swagger2MarkupConverter; /** * A marker interface which must be implemented by an extension diff --git a/src/main/java/io/github/robwin/swagger2markup/spi/OverviewDocumentExtension.java b/src/main/java/io/github/swagger2markup/spi/OverviewDocumentExtension.java similarity index 97% rename from src/main/java/io/github/robwin/swagger2markup/spi/OverviewDocumentExtension.java rename to src/main/java/io/github/swagger2markup/spi/OverviewDocumentExtension.java index e11f64ae..c3e86773 100644 --- a/src/main/java/io/github/robwin/swagger2markup/spi/OverviewDocumentExtension.java +++ b/src/main/java/io/github/swagger2markup/spi/OverviewDocumentExtension.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; import io.github.robwin.markup.builder.MarkupDocBuilder; diff --git a/src/main/java/io/github/robwin/swagger2markup/spi/PathsDocumentExtension.java b/src/main/java/io/github/swagger2markup/spi/PathsDocumentExtension.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/spi/PathsDocumentExtension.java rename to src/main/java/io/github/swagger2markup/spi/PathsDocumentExtension.java index a9072d05..59134f5c 100644 --- a/src/main/java/io/github/robwin/swagger2markup/spi/PathsDocumentExtension.java +++ b/src/main/java/io/github/swagger2markup/spi/PathsDocumentExtension.java @@ -14,12 +14,12 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; import com.google.common.base.Optional; import io.github.robwin.markup.builder.MarkupDocBuilder; -import io.github.robwin.swagger2markup.GroupBy; -import io.github.robwin.swagger2markup.internal.model.PathOperation; +import io.github.swagger2markup.GroupBy; +import io.github.swagger2markup.internal.model.PathOperation; import org.apache.commons.lang3.Validate; /** diff --git a/src/main/java/io/github/robwin/swagger2markup/spi/SecurityDocumentExtension.java b/src/main/java/io/github/swagger2markup/spi/SecurityDocumentExtension.java similarity index 98% rename from src/main/java/io/github/robwin/swagger2markup/spi/SecurityDocumentExtension.java rename to src/main/java/io/github/swagger2markup/spi/SecurityDocumentExtension.java index 2b3eff5f..f48cbdb8 100644 --- a/src/main/java/io/github/robwin/swagger2markup/spi/SecurityDocumentExtension.java +++ b/src/main/java/io/github/swagger2markup/spi/SecurityDocumentExtension.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; import com.google.common.base.Optional; import io.github.robwin.markup.builder.MarkupDocBuilder; diff --git a/src/main/java/io/github/robwin/swagger2markup/spi/SwaggerModelExtension.java b/src/main/java/io/github/swagger2markup/spi/SwaggerModelExtension.java similarity index 95% rename from src/main/java/io/github/robwin/swagger2markup/spi/SwaggerModelExtension.java rename to src/main/java/io/github/swagger2markup/spi/SwaggerModelExtension.java index 6221a7b2..e4f60382 100644 --- a/src/main/java/io/github/robwin/swagger2markup/spi/SwaggerModelExtension.java +++ b/src/main/java/io/github/swagger2markup/spi/SwaggerModelExtension.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; import io.swagger.models.Swagger; diff --git a/src/main/java/io/github/robwin/swagger2markup/internal/utils/IOUtils.java b/src/main/java/io/github/swagger2markup/utils/IOUtils.java similarity index 86% rename from src/main/java/io/github/robwin/swagger2markup/internal/utils/IOUtils.java rename to src/main/java/io/github/swagger2markup/utils/IOUtils.java index f4566117..660c9969 100644 --- a/src/main/java/io/github/robwin/swagger2markup/internal/utils/IOUtils.java +++ b/src/main/java/io/github/swagger2markup/utils/IOUtils.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.github.robwin.swagger2markup.internal.utils; +package io.github.swagger2markup.utils; import org.apache.commons.lang3.StringUtils; @@ -30,7 +30,7 @@ public class IOUtils { private static final Pattern NAME_FORBIDDEN_PATTERN = Pattern.compile("[^0-9A-Za-z-_]+"); /** - * Create a normalized name from an arbitrary string.
+ * Create a normalized name from an arbitrary string.
* Paths separators are replaced, so this function can't be applied on a whole path, but must be called on each path sections. * * @param name current name of the file @@ -45,12 +45,12 @@ public class IOUtils { } /** - * Create a reader from specified {@code source}.
+ * Create a reader from specified {@code source}.
* Returned reader should be explicitly closed after use. * * @param uri source URI * @return reader - * @throws IOException + * @throws IOException if the connection cannot be opened */ public static Reader uriReader(URI uri) throws IOException { return new BufferedReader(new InputStreamReader(uri.toURL().openStream(), StandardCharsets.UTF_8)); @@ -62,6 +62,6 @@ public class IOUtils { * @return URI parent */ public static URI uriParent(URI uri) { - return uri.getPath().endsWith("/") ? uri.resolve("..") : uri.resolve("."); + return uri.getPath().endsWith("/") ? uri.resolve("src/main") : uri.resolve("."); } } diff --git a/src/test/java/io/github/robwin/swagger2markup/assertions/DiffAssert.java b/src/test/java/io/github/robwin/swagger2markup/assertions/DiffAssert.java deleted file mode 100644 index ccdc477a..00000000 --- a/src/test/java/io/github/robwin/swagger2markup/assertions/DiffAssert.java +++ /dev/null @@ -1,88 +0,0 @@ -/* - * - * Copyright 2016 Robert Winkler - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * - */ -package io.github.robwin.swagger2markup.assertions; - - -import com.sksamuel.diffpatch.DiffMatchPatch; -import org.apache.commons.io.IOUtils; -import org.assertj.core.api.AbstractAssert; - -import java.io.BufferedWriter; -import java.io.IOException; -import java.nio.charset.Charset; -import java.nio.file.Files; -import java.nio.file.Path; -import java.util.LinkedList; - -import static org.assertj.core.api.Assertions.assertThat; - -public class DiffAssert extends AbstractAssert{ - - public DiffAssert(Path actual) { - super(actual, DiffAssert.class); - } - - /** - * Verifies that the content of the actual File is equal to the given one. - * - * @param expected the given value to compare the actual value to. - * @param reportPath the path to the report which should be generated if the files differ. - * @return {@code this} assertion object. - * @throws AssertionError if the actual value is not equal to the given one or if the actual value is {@code null}.. - */ - public DiffAssert isEqualTo(Path expected, Path reportPath) { - LinkedList diffs = diff(actual, expected); - boolean allDiffsAreEqual = assertThatAllDiffsAreEqual(diffs); - if(!allDiffsAreEqual){ - writeHtmlReport(reportPath, diffs); - } - assertThat(allDiffsAreEqual).as("The content of the following files differ. Actual: %s, Expected %s. Check the HTML report for more details: %s", actual.toAbsolutePath(), expected.toAbsolutePath(), reportPath.toAbsolutePath()).isTrue(); - return myself; - } - - public boolean assertThatAllDiffsAreEqual(LinkedList diffs){ - for(DiffMatchPatch.Diff diff : diffs){ - if(diff.operation == DiffMatchPatch.Operation.DELETE || diff.operation == DiffMatchPatch.Operation.INSERT){ - return false; - } - } - return true; - } - - private static LinkedList diff(Path actual, Path expected){ - DiffMatchPatch differ = new DiffMatchPatch(); - try { - return differ.diff_main(IOUtils.toString(expected.toUri()), IOUtils.toString(actual.toUri()), false); - } catch (IOException e) { - throw new RuntimeException("Failed to diff files.", e); - } - } - - private static void writeHtmlReport(Path reportPath, LinkedList diffs){ - DiffMatchPatch differ = new DiffMatchPatch(); - try { - Files.createDirectories(reportPath.getParent()); - try (BufferedWriter writer = Files.newBufferedWriter(reportPath, Charset.forName("UTF-8"))) { - writer.write(differ.diff_prettyHtml(diffs)); - } - } catch (IOException e) { - throw new RuntimeException(String.format("Failed to write report %s", reportPath.toAbsolutePath()), e); - } - } -} diff --git a/src/test/java/io/github/robwin/swagger2markup/assertions/DiffAssertions.java b/src/test/java/io/github/robwin/swagger2markup/assertions/DiffAssertions.java deleted file mode 100644 index 4ac70e52..00000000 --- a/src/test/java/io/github/robwin/swagger2markup/assertions/DiffAssertions.java +++ /dev/null @@ -1,43 +0,0 @@ -/* - * - * Copyright 2016 Robert Winkler - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * - */ -package io.github.robwin.swagger2markup.assertions; - -import org.apache.commons.lang3.Validate; - -import java.nio.file.Path; - -/** - * Entry point for assertion methods for diffing files. - * - * @author Robert Winkler - */ -public class DiffAssertions { - - /** - * Creates a new instance of {@link DiffAssert}. - * - * @param actual the the actual File path. - * @return the created assertion object. - */ - - public static DiffAssert assertThat(Path actual) { - Validate.notNull(actual, "actual must not be null"); - return new DiffAssert(actual); - } -} diff --git a/src/test/java/io/github/robwin/swagger2markup/AsciidocConverterTest.java b/src/test/java/io/github/swagger2markup/AsciidocConverterTest.java similarity index 78% rename from src/test/java/io/github/robwin/swagger2markup/AsciidocConverterTest.java rename to src/test/java/io/github/swagger2markup/AsciidocConverterTest.java index 60af4b79..88c0ec68 100644 --- a/src/test/java/io/github/robwin/swagger2markup/AsciidocConverterTest.java +++ b/src/test/java/io/github/swagger2markup/AsciidocConverterTest.java @@ -13,13 +13,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; -import io.github.robwin.swagger2markup.assertions.DiffUtils; -import io.github.robwin.swagger2markup.internal.extensions.DynamicDefinitionsDocumentExtension; -import io.github.robwin.swagger2markup.internal.extensions.DynamicPathsDocumentExtension; -import io.github.robwin.swagger2markup.internal.extensions.SchemaExtension; -import io.github.robwin.swagger2markup.internal.extensions.SpringRestDocsExtension; +import io.github.swagger2markup.assertions.DiffUtils; import org.apache.commons.io.FileUtils; import org.apache.commons.io.IOUtils; import org.junit.Before; @@ -108,35 +104,6 @@ public class AsciidocConverterTest { DiffUtils.assertThatAllFilesAreEqual(outputDirectory, expectedFilesDirectory, "testSwagger2AsciiDocConversion.html"); } - @Test - public void testSwagger2AsciiDocConversionWithSpringRestDocsExtension() throws IOException, URISyntaxException { - //Given - String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/yaml/swagger_petstore.yaml")); - Path outputDirectory = Paths.get("build/docs/asciidoc/spring_rest_docs"); - FileUtils.deleteQuietly(outputDirectory.toFile()); - - //When - Swagger2MarkupExtensionRegistry registry = Swagger2MarkupExtensionRegistry.ofEmpty() - .withExtension(new SpringRestDocsExtension(Paths.get("src/test/resources/docs/asciidoc/paths").toUri()).withDefaultSnippets()) - .build(); - - Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults() - .build(); - - Swagger2MarkupConverter.from(swaggerJsonString) - .withConfig(config) - .withExtensionRegistry(registry) - .build() - .intoFolder(outputDirectory); - - //Then - String[] files = outputDirectory.toFile().list(); - assertThat(files).hasSize(4).containsAll(expectedFiles); - - Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected_results/asciidoc/spring_rest_docs").toURI()); - DiffUtils.assertThatAllFilesAreEqual(outputDirectory, expectedFilesDirectory, "testSwagger2AsciiDocConversionWithSpringRestDocsExtension.html"); - } - @Test public void testSwagger2AsciiDocConversionWithExamples() throws IOException, URISyntaxException { //Given @@ -402,58 +369,4 @@ public class AsciidocConverterTest { assertThat(new String(Files.readAllBytes(outputDirectory.resolve("overview.adoc")), Charset.forName("UTF-8"))) .contains("== Sch\u00E9ma d'URI"); } - - @Test - public void testSwagger2AsciiDocExtensions() throws IOException, URISyntaxException { - //Given - Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI()); - Path outputDirectory = Paths.get("build/docs/asciidoc/generated"); - FileUtils.deleteQuietly(outputDirectory.toFile()); - - //When - Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults() - .build(); - Swagger2MarkupExtensionRegistry registry = Swagger2MarkupExtensionRegistry.ofEmpty() - .withExtension(new DynamicDefinitionsDocumentExtension(Paths.get("src/test/resources/docs/asciidoc/extensions"))) - .withExtension(new DynamicPathsDocumentExtension(Paths.get("src/test/resources/docs/asciidoc/extensions"))) - .build(); - Swagger2MarkupConverter.from(file) - .withConfig(config) - .withExtensionRegistry(registry) - .build() - .intoFolder(outputDirectory); - - //Then - assertThat(new String(Files.readAllBytes(outputDirectory.resolve("paths.adoc")))).contains( - "Pet update request extension"); - assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.adoc")))).contains( - "Pet extension"); - - } - - @Test - public void testSwagger2AsciiDocSchemaExtension() throws IOException, URISyntaxException { - //Given - Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI()); - Path outputDirectory = Paths.get("build/docs/asciidoc/generated"); - FileUtils.deleteQuietly(outputDirectory.toFile()); - - //When - Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults() - .build(); - Swagger2MarkupExtensionRegistry registry = Swagger2MarkupExtensionRegistry.ofEmpty() - .withExtension(new SchemaExtension(Paths.get("src/test/resources/docs/asciidoc/extensions").toUri())) - .build(); - Swagger2MarkupConverter.from(file) - .withConfig(config) - .withExtensionRegistry(registry) - .build() - .intoFolder(outputDirectory); - - //Then - assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.adoc")))).contains( - "=== Pet"); - assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.adoc")))).contains( - "==== XML Schema"); - } } diff --git a/src/test/java/io/github/robwin/swagger2markup/GeneralConverterTest.java b/src/test/java/io/github/swagger2markup/GeneralConverterTest.java similarity index 94% rename from src/test/java/io/github/robwin/swagger2markup/GeneralConverterTest.java rename to src/test/java/io/github/swagger2markup/GeneralConverterTest.java index d194f180..5412c06a 100644 --- a/src/test/java/io/github/robwin/swagger2markup/GeneralConverterTest.java +++ b/src/test/java/io/github/swagger2markup/GeneralConverterTest.java @@ -13,8 +13,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; +import io.github.swagger2markup.utils.IOUtils; import io.swagger.models.Swagger; import org.junit.Test; @@ -44,7 +45,7 @@ public class GeneralConverterTest { .build(); //Then - URI baseUri = io.github.robwin.swagger2markup.internal.utils.IOUtils.uriParent(converter.getContext().getSwaggerLocation()); + URI baseUri = IOUtils.uriParent(converter.getContext().getSwaggerLocation()); assertThat(converter.getContext().getConfig().getDefinitionDescriptionsUri()).isEqualTo(baseUri); assertThat(converter.getContext().getConfig().getOperationDescriptionsUri()).isEqualTo(baseUri); } diff --git a/src/test/java/io/github/robwin/swagger2markup/MarkdownConverterTest.java b/src/test/java/io/github/swagger2markup/MarkdownConverterTest.java similarity index 84% rename from src/test/java/io/github/robwin/swagger2markup/MarkdownConverterTest.java rename to src/test/java/io/github/swagger2markup/MarkdownConverterTest.java index 63285c1a..ccd836b7 100644 --- a/src/test/java/io/github/robwin/swagger2markup/MarkdownConverterTest.java +++ b/src/test/java/io/github/swagger2markup/MarkdownConverterTest.java @@ -13,16 +13,14 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; import com.google.common.collect.Maps; import com.google.common.collect.Sets; import io.github.robwin.markup.builder.MarkupLanguage; -import io.github.robwin.swagger2markup.assertions.DiffUtils; -import io.github.robwin.swagger2markup.internal.extensions.DynamicDefinitionsDocumentExtension; -import io.github.robwin.swagger2markup.internal.extensions.DynamicPathsDocumentExtension; +import io.github.swagger2markup.assertions.DiffUtils; import org.apache.commons.io.FileUtils; import org.junit.Before; import org.junit.Test; @@ -164,35 +162,6 @@ public class MarkdownConverterTest { } - @Test - public void testSwagger2MarkdownExtensions() throws IOException, URISyntaxException { - //Given - Path file = Paths.get(MarkdownConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI()); - Path outputDirectory = Paths.get("build/docs/markdown/generated"); - FileUtils.deleteQuietly(outputDirectory.toFile()); - - //When - Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults() - .withMarkupLanguage(MarkupLanguage.MARKDOWN) - .build(); - Swagger2MarkupExtensionRegistry registry = Swagger2MarkupExtensionRegistry.ofEmpty() - .withExtension(new DynamicDefinitionsDocumentExtension(Paths.get("src/test/resources/docs/markdown/extensions"))) - .withExtension(new DynamicPathsDocumentExtension(Paths.get("src/test/resources/docs/markdown/extensions"))) - .build(); - Swagger2MarkupConverter.from(file) - .withConfig(config) - .withExtensionRegistry(registry) - .build() - .intoFolder(outputDirectory); - - //Then - assertThat(new String(Files.readAllBytes(outputDirectory.resolve("paths.md")))).contains( - "Pet update request extension"); - assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.md")))).contains( - "Pet extension"); - - } - /** * Given a markdown document to search, this checks to see if the specified tables * have all of the expected fields listed. diff --git a/src/test/java/io/github/robwin/swagger2markup/Swagger2MarkupConfigTest.java b/src/test/java/io/github/swagger2markup/Swagger2MarkupConfigTest.java similarity index 99% rename from src/test/java/io/github/robwin/swagger2markup/Swagger2MarkupConfigTest.java rename to src/test/java/io/github/swagger2markup/Swagger2MarkupConfigTest.java index 1385c308..f1cece52 100644 --- a/src/test/java/io/github/robwin/swagger2markup/Swagger2MarkupConfigTest.java +++ b/src/test/java/io/github/swagger2markup/Swagger2MarkupConfigTest.java @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup; +package io.github.swagger2markup; import com.google.common.collect.Ordering; import io.github.robwin.markup.builder.MarkupLanguage; diff --git a/src/test/java/io/github/robwin/swagger2markup/assertions/DiffUtils.java b/src/test/java/io/github/swagger2markup/assertions/DiffUtils.java similarity index 95% rename from src/test/java/io/github/robwin/swagger2markup/assertions/DiffUtils.java rename to src/test/java/io/github/swagger2markup/assertions/DiffUtils.java index 281b83c0..c290f9b6 100644 --- a/src/test/java/io/github/robwin/swagger2markup/assertions/DiffUtils.java +++ b/src/test/java/io/github/swagger2markup/assertions/DiffUtils.java @@ -16,8 +16,9 @@ * * */ -package io.github.robwin.swagger2markup.assertions; +package io.github.swagger2markup.assertions; +import io.github.robwin.diff.DiffAssertions; import org.slf4j.Logger; import org.slf4j.LoggerFactory; diff --git a/src/test/java/io/github/robwin/swagger2markup/spi/MySwaggerModelExtension.java b/src/test/java/io/github/swagger2markup/spi/MySwaggerModelExtension.java similarity index 95% rename from src/test/java/io/github/robwin/swagger2markup/spi/MySwaggerModelExtension.java rename to src/test/java/io/github/swagger2markup/spi/MySwaggerModelExtension.java index f8c79c5d..46b87168 100644 --- a/src/test/java/io/github/robwin/swagger2markup/spi/MySwaggerModelExtension.java +++ b/src/test/java/io/github/swagger2markup/spi/MySwaggerModelExtension.java @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; import io.swagger.models.Swagger; diff --git a/src/test/java/io/github/robwin/swagger2markup/spi/Swagger2MarkupExtensionRegistryTest.java b/src/test/java/io/github/swagger2markup/spi/Swagger2MarkupExtensionRegistryTest.java similarity index 79% rename from src/test/java/io/github/robwin/swagger2markup/spi/Swagger2MarkupExtensionRegistryTest.java rename to src/test/java/io/github/swagger2markup/spi/Swagger2MarkupExtensionRegistryTest.java index 50188d26..fe9c8eac 100644 --- a/src/test/java/io/github/robwin/swagger2markup/spi/Swagger2MarkupExtensionRegistryTest.java +++ b/src/test/java/io/github/swagger2markup/spi/Swagger2MarkupExtensionRegistryTest.java @@ -13,15 +13,12 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.github.robwin.swagger2markup.spi; +package io.github.swagger2markup.spi; -import io.github.robwin.swagger2markup.Swagger2MarkupExtensionRegistry; -import io.github.robwin.swagger2markup.internal.extensions.DynamicDefinitionsDocumentExtension; -import io.github.robwin.swagger2markup.internal.extensions.DynamicPathsDocumentExtension; +import io.github.swagger2markup.Swagger2MarkupExtensionRegistry; import io.swagger.models.Swagger; import org.junit.Test; -import java.nio.file.Paths; import java.util.Arrays; import java.util.List; @@ -35,8 +32,6 @@ public class Swagger2MarkupExtensionRegistryTest { Swagger2MarkupExtensionRegistry.Builder registryBuilder = Swagger2MarkupExtensionRegistry.ofDefaults(); registryBuilder.withExtension(new MySwaggerModelExtension()); - registryBuilder.withExtension(new DynamicDefinitionsDocumentExtension(Paths.get("src/test/resources/docs/asciidoc/extensions"))); - registryBuilder.withExtension(new DynamicPathsDocumentExtension(Paths.get("src/test/resources/docs/asciidoc/extensions"))); try { registryBuilder.withExtension(new AbstractExtension() {