diff --git a/.travis.yml b/.travis.yml index e7ee998b2d..f17634a3f8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,4 +12,4 @@ after_success: branches: only: - master - - 2.0 \ No newline at end of file + - 1.5 \ No newline at end of file diff --git a/LICENSE b/LICENSE index ebfd64c493..84505a38bb 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright 2016 SmartBear Software +Copyright 2018 SmartBear Software Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index 54a5828f1a..79dd503275 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Swagger Core library -[![Build Status](https://travis-ci.org/swagger-api/swagger-core.svg?branch=2.0)](https://travis-ci.org/swagger-api/swagger-core) +[![Build Status](https://travis-ci.org/swagger-api/swagger-core.svg?branch=master)](https://travis-ci.org/swagger-api/swagger-core) The goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, Swagger removes the guesswork in calling the service. @@ -37,7 +37,7 @@ Swagger core Version | Release Date | OpenAPI Spec compatibility | Notes | 1.5.18 | 2018-01-22 | 2.0 | [tag v1.5.18](https://github.com/swagger-api/swagger-core/tree/v1.5.18) | Supported 1.5.17 | 2017-11-21 | 2.0 | [tag v1.5.17](https://github.com/swagger-api/swagger-core/tree/v1.5.17) | Supported 1.5.16 | 2017-07-15 | 2.0 | [tag v1.5.16](https://github.com/swagger-api/swagger-core/tree/v1.5.16) | Supported -1.3.12 | 2014-12-23 | 1.2 | [tag v1.3.12](https://github.com/swagger-api/swagger-core/tree/v1.3.12) | Supported +1.3.12 | 2014-12-23 | 1.2 | [tag v1.3.12](https://github.com/swagger-api/swagger-core/tree/v1.3.12) | Deprecated 1.2.4 | 2013-06-19 | 1.1 | [tag swagger-project_2.10.0-1.2.4](https://github.com/swagger-api/swagger-core/tree/swagger-project_2.10.0-1.2.4) | Deprecated 1.0.0 | 2011-10-16 | 1.0 | [tag v1.0](https://github.com/swagger-api/swagger-core/tree/v1.0) | Deprecated @@ -80,7 +80,7 @@ The samples have moved to [a new repository](https://github.com/swagger-api/swag ## License ``` -Copyright 2016 SmartBear Software +Copyright 2018 SmartBear Software Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -92,167 +92,3 @@ 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. ``` - -## v2.0.1 - -### Notable Features: -* JDK 9/10 support in build (#2735) - -### Bug fixes: - -* Supports `OpenAPIExtension` `decorateOperation` (#2748) -* Fix path building for resources without leading slashes (#2751) -* Fix stackOverflowError for circuclar reference in jackson ModelResolver (#2740) -* Fix CVE-2018-7489 - jackson version 2.9.5 (#2755) -* Fix random build error (#2752) -* Fix NPE in Reader with null config (#2736) -* Improve support for #2635 -* Improve support for #2635 -* Correctly resolve array schema annotations with ref schema items (#2763) -* Fix security scheme name/key resolving (#2767) - -## v2.0.0 - -### Notable Features: - -* First official release with OpenAPI 3.0 support -* Brand new [2.0 wiki](https://github.com/swagger-api/swagger-core/wiki) -* Jackson 2.9.4 (#2655) -* JsonView support (#2079) -* internal refactor (#2593) -* Updated annotations target (#2653) -* deprecates Schema.readOnly and introduces accessMode field (#2379) -* Class level response annotations (#2685) -* rework JsonProperty, readonly/writeonly support (#2169) -* JsonIdentity support (#2704) -* Complex types support in @ExtensionProperty (#2723) -* Adds `openapi.json` and `openapi.yaml` to known locations (#2727) - -### Bug fixes: - -* Annotation inheritance from interfaces (#2644) -* @Produces full support (#2646) -* Reader Correctly skips non JAX-RS methods (#2656) -* fix models osgi export packages (#2663) -* avoid duplicate operationId (#2433) -* file upload and multipart fixes (#2689) -* support ArraySchema context annotations in container type properties (#2616) -* Path in Class level removed for subresources (#2632) -* Configuration loading from servlet path (#2706) - -## v2.0.0-rc4 - -### Notable Features: - -* See also rc1, r2, and rc3 release notes ([v2.0.0-rc1](https://github.com/swagger-api/swagger-core/releases/tag/v2.0.0-rc1), [v2.0.0-rc2](https://github.com/swagger-api/swagger-core/releases/tag/v2.0.0-rc2), [v2.0.0-rc3](https://github.com/swagger-api/swagger-core/releases/tag/v2.0.0-rc3)) -* Fourth official release candidate of OpenAPI 3.0 support. Swagger-core now produces OpenAPI 3.0 specs only. swagger-core 2.0 version is not backward compatible with previous 1.x versions. -* Available on Maven central, and the sources are in the 2.0 branch. PRs should be submitted against the 2.0 branch. -* Enhanced polymorphic schemas resolving (#2620) -* Remove guava dependency from core code (#2618) -* Subresource resolving (#2607) -* Additional properties as `Boolean` or `Schema` (#2461) -* Versions updates -* Enhanced `RequestBody` and other annotations support (#2562) -* Extended set of [samples](https://github.com/swagger-api/swagger-samples/tree/2.0/java) -* Various bug fixes and improvements - -### Limitations - -- Reader extensions full support _(swagger-jaxrs2)_ -- Integration layer enhancements:config file location enhanced loading, additional loaders, etc. _(swagger-integration, swagger-jaxrs)_ -- JsonIdentity support _(swagger-core)_ -- `MatrixParam` annotation support - - -## v2.0.0-rc3 - -### Notable Features: - -- See also [rc1 and rc2 release notes]([v2.0.0-rc1](https://github.com/swagger-api/swagger-core/releases/tag/v2.0.0-rc1), [v2.0.0-rc2](https://github.com/swagger-api/swagger-core/releases/tag/v2.0.0-rc2)) -- Third official release candidate of OpenAPI 3.0 support. swagger-core now produces OpenAPI 3.0 specs only. swagger-core 2.0 version is not backward compatible with previous 1.x versions. -- Available on Maven central, and the sources are in the 2.0 branch. PRs should be submitted against the 2.0 branch. -- **Project `groupId` and package naming change! (#2485, see also above)** -- Enhanced and stable annotations (#2481) -- Repeatable annotations support (#2481) -- Swagger `ServletContainerInitializer` based startup scanning (#2504, see related samples in [samples](https://github.com/swagger-api/swagger-samples/tree/2.0/java), [jersey sample](https://github.com/swagger-api/swagger-samples/tree/2.0/java/java-jersey2-initializer-configfile), [RESTEasy sample](https://github.com/swagger-api/swagger-samples/tree/2.0/java/java-resteasy-initializer-configfile)) -- `@OpenAPIDefinition` support (#2517) -- `@ApplicationPath` support (#2489) -- Full `@Schema` elements resolving (#2476) -- `@Hidden` support (#2528) -- `@Schema.subTypes` support (#2511) -- Better generics support in schema resolution (#2483) -- Enhanced `@ArraySchema` support (#2501) -- Enhanced Response schema resolving (#2513) -- Extended set of [samples](https://github.com/swagger-api/swagger-samples/tree/2.0/java) -- Improved [2.0 Wiki](https://github.com/swagger-api/swagger-core/wiki) -- Improved Annotation javadocs (#2541) -- Various bug fixes and improvements - -### Limitations - -- Reader sub-resources support _(swagger-jaxrs2)_ -- Reader extensions full support _(swagger-jaxrs2)_ -- Integration layer enhancements:config file location enhanced loading, additional loaders, etc. _(swagger-integration, swagger-jaxrs)_ -- JsonIdentity support _(swagger-core)_ -- `MatrixParam` annotation support - -## v2.0.0-rc2 - -### Notable Features: - -- See also [rc1 release notes](https://github.com/swagger-api/swagger-core/releases/tag/v2.0.0-rc1) -- Second official release candidate of OpenAPI 3.0 support. swagger-core now produces OpenAPI 3.0 specs only. swagger-core 2.0 version is not backward compatible with previous 1.x versions. -- Available on Maven central, and the sources are in the 2.0 branch. PRs should be submitted against the 2.0 branch. -- `Example/Examples` support (#2416) -- New [2.0 Wiki](https://github.com/swagger-api/swagger-core/wiki) -- Enhanced security support (#2450) -- Enhanced request body support (#2401) -- Response header support (#2427) -- Enhanced support for Parameter, Schema and Content (#2404) -- Specification Filter (#2452) -- Reader listener support (#2464) -- Encoding support (#2463) -- Consumes/Produces full support(#2404) -- Annotation javadocs (#2394) -- Full sample code for [jersey2](https://github.com/swagger-api/swagger-samples/tree/2.0/java/java-jersey2) and [dropwizard](https://github.com/swagger-api/swagger-samples/tree/2.0/java/java-dropwizard) -- Updated dependencies -- Various bug fixes - -### Limitations - -- Resolve resource operations also when not annotated with `@Operation` _(swagger-jaxrs2)_ -- Implement `subtypes` field in `Schema` annotation, with related resolver processing _(swagger-annotations / core)_ -- Overriding full support _(swagger-core)_ - * Schema annotation `type` + `format` full support _(swagger-core)_ -- Reader sub-resources support _(swagger-jaxrs2)_ -- Reader extensions full support _(swagger-jaxrs2)_ -- Integration layer enhancements:config file location enhanced loading, additional loaders, etc. _(swagger-integration, swagger-jaxrs)_ -- JsonIdentity support _(swagger-core)_ -- `MatrixParam` annotation support - -## v2.0.0-rc1 - -### Notable Features: - -- First official release candidate of OpenApi 3.0 support. swagger-core now produces OpenAPI 3.0 specs only. swagger-core 2.0 version is not backward compatible with previous 1.x versions. -- Available on Maven central, and the sources are in the 2.0 branch. PRs should be submitted against the 2.0 branch. -- Swagger JAX-RS 2 support -- Java 8 -- Consistent integration mechanism - -### Limitations - -- Resolve resource operations also when not annotated with `@Operation` _(swagger-jaxrs2)_ -- Implement `subtypes` field in `Schema` annotation, with related resolver processing _(swagger-annotations / core)_ -- Overriding full support _(swagger-core)_ - * Schema annotation `type` + `format` full support _(swagger-core)_ - * Schema annotation `implementation` field full support _(swagger-core)_ -- Filter / Reader listener support _(swagger-jaxrs2)_ -- Reader sub-resources support _(swagger-jaxrs2)_ -- Reader extensions full support _(swagger-jaxrs2)_ -- Annotations javadocs _(swagger-annotations)_ -- Annotations default values enhancement _(swagger-annotations / core)_ -- Integration layer enhancements:config file location enhanced loading, additional loaders, etc. _(swagger-integration, swagger-jaxrs)_ -- Consumes/Produces full support _(swagger-jaxrs2)_ -- JsonIdentity support _(swagger-core)_ -- `MatrixParam` annotation support