Swagger-Core 1.5.4 Released!

This release includes major functionality improvements in swagger-core, including migration of the swagger-servlet project for annotating non JAX-RS-based projects to support swagger.

Please note that we have moved support for the Play! framework into a separate project

As with all swagger OSS projects, we couldn’t have made so much progress without support from the community. A special thanks to @webron, @lugaru1234, @iushankin, @tomtit and @elakito for all your efforts!

Notable features

• Added support for shared parameters in the root of the swagger definition (#1317)
• Added better support for scanning generic models (#1344)
• New models to represent references in parameters, responses (#1388)
• Updated OSGi exports for swagger-jars (#1412)
• Vendor extensions added to all models where allowed by the swagger spec (#1416, #1414)
• Support for plain servlets via swagger-servlet (#919)
• Moved all tests to use testng framework (#1434)
• Added support for java.validation.Pattern (#1439)
• Support for processing annotations on interfaces (#1454)
• Parse support for java8 java.time.LocalDate and java.time.LocalDateTime (#1475)
• Parse support for java.util.Optional (#1479)
• Improved parsing of composed models (#1373)
• Shared responses model definitions in root swagger object (#1489)
• Example payload support for all parameters added, now adds mime-specific support (#1500)

Notable bug fixes

• support relative refs starting with / (1393
• Proper support for form data under jersey 2 (#1387)
• Recursive resource scanning fix (#1424)
• Use nickname if specified for operationId on operations (#1440)
• Parse bug for @Consumes and @Produces at api root (#1448)
• Deserialization loses description (#1462)
• Added description field in security definitions (#1463)
• Fixed property parsing for MIN_ITEMS and MAX_ITEMS (#1477)
• Better enum support for non-string types (#1418)

Swagger-core 1.5.3 Released!

This release introduces important support for references throughout the swagger object, as well as a shift in development workflow of the swagger project. Please see here for details of that change.

Notable features

• Updated Jackson version to 2.4.6, Guava to 18
• Improved reference support refs in a more general fashion, included relative ref support #1271
• Added vendor extensions to Model, Property interfaces #1350
• Added children to ObjectProperty. This allows for nested schema support #1314
• Migration of more tests from scala to Java #1332, #1337, #1345, #1348

Notable bug fixes

• Fixed StringProperty.equals() #1331
• Fixed scanning of non JAX-RS resources #1343

Swagger-core 1.5.2 Released!

Maintenance release.

Revert breaking change introduced by #1297.

Swagger-core 1.5.1 Released!

First service release for the 1.5 branch.

Notable features

• Tags are now removed if all their operations are filtered out - #977
• (BREAKING CHANGE) Default collectionFormat for query and form parameters is now multi - #1160
• Added @ApiParam#hidden() to hide parameters - #1188
• Changed scanning order of @SwaggerDefinition - #1243
• Added range support for @ApiModelProperty#allowableValues() - #1276
• Added support for relative references - #1229

Notable bug fixes

• Fixed NPE in some filtering cases - #1141
• Fixed inclusion of XML structure - #1143, #1292
• Fixed funky behavior when adding a body @ApiImplictParameter - #1150
• Fixed parsing of paths with regex expressions - #1153
• Fixed representation of BigDecimal and BigInteger - #1154
• Fixed model property edge case - #1155
• Fixed processing of unwanted body parameters - #1176, #1191
• Fixed Swagger definition generation for self-referencing models - #1178
• Processing of @Deprecated now works - #1183, #1212
• Fixed definition generation when FormDataBodyPart is used in Jersey - #1187
• Proper handling of root paths - #1189
• Fixed subresource scanning - #1215
• Fixed support for BeanConfig in the Mule module - #1234
• Corrected MANIFEST entries for OSGi support - #1285

Notable changes

• Initial migration of tests from scala to Java based on TestNG

Swagger-core 1.5.0 Released!

This is the first formal release of swagger-core with 2.0 spec support. Many thanks to the community for furthering the development of swagger.

Please note! We have repackaged the project from com.wordnik to io.swagger. The code API is the same!

Major changes

• Better generics support - #498, #1096
• No-annotations support - #978
• Support for bean validation (JSR303) - #800
• Improved composition support - #802, #852
• Support for remote references - #864
• More samples migrated to 1.5 and moved to a new repository at swagger-samples - #898,
• Added parsing of @Api/@ApiOperation#protocols() - #953
• Improved container support - #954, #955, #1032, #976
• Improved annotation inheritance support - #1072
• Added support for constructor parameter declarations - #1085
• Introduced a new annotation-based configuration method

Bug fixes

• Subresource integration fixes - #394, #942
• Fixed support for ranges in allowableValues - #892, #957
• Support for @ApiImplicitParam - #905
• Request body not being picked up - #943
• NPE when configuring swagger-core - #951
• Fixed processing of @Api/@ApiOperation#produces()/consumes() - #952
• Enum support - #1019, #1004
• File upload support for Jersey2 - #1015
• Recursive packages scanning - #1011
• Examples are now objects - #988
• Fixed authorization inheritance - #1041
• Fixed primitive support for responses - #1120

Swagger-core 1.5.0-M2 Released!

Swagger core has undergone a major update to increase support of the Swagger 2.0 specification. Major features include support for JAXRS sub resources and Bean Validations.

Usage notes

1.5.0-M2 is API compatible with M1. It has improved stability as well as configuration options.

Major changes

Scala support has been moved to a separate project so it can evolve independently. Play! framework support will also be treated the same way.

If you need Play! support, please use swagger-core-1.3.12 until the play module is released.

Notable features
#942, #925 subresource support
#936 support for example objects
#922 better support for jaxrs regex path params
#897 support for schemes, other 2.0 support in BeanConfig
#879 multiple packages can be scanned as CSV list
#878, #841 added support for tags in operations, bootstrap
#876 glassfish PATCH annotation support
#869 response headers supported
#854 read-only fields supported
#844 JAXB default value support
#836 spec filter support
#833 model converter support
#801 BeanValidations support for JSR-303, JSR-349
#519 @JsonIgnoreProperties support
#505 @XmlElementWrapper support

Notable bug fixes
#906 http methods detected case insensitive
#886 Java 8 compilation supported

Swagger-core v1.5.2-M1 Released!

Minor release to support the following:

• Supporting tags in operations #878
• Return proper response type for Response.Status #877

Swagger-core v1.5.0-M1 Released!

The Swagger team is proud to announce the M1 release of three of our main libraries and tools: swagger-js, swagger-ui and swagger-core. All release provide official initial support for Swagger 2.0’s main features. The missing features will be added in the next milestone releases until the final release is available.

In order to better improve these libraries and tools, we ask that you start using them and provide us with feedback in form of issues on the github repository. The issues are a huge help in finding what’s missing or not working properly (though note some issues are already submitted). We would also appreciate any PRs that improve existing or new tickets.

These releases could not have happened without the intensive support of the Swagger community. Each of the projects had a few PRs that really helped us push these projects forward!

Be aware that the release notes contain the notable changes, but there may some changes that we missed in the list.

Notable Features:

• First official milestone release of Swagger 2.0 support. Swagger-Core now produces Swagger 2.0 specs only.
• (Software) API compatible with 1.3.6+. For supported configurations, only a dependency upgrade is required. You may need a slight alteration to your configuration.
• Swagger-core is pure Java. Only the tests are in Scala, and those do not affect the dependencies of the library.
• Model introspection is now done by Jackson, and is much more robust.
• No more reliance on com.sun.* packages, making swagger-core safe for Google App Engine deployments.
• New, extension model for processing different annotation types. Extensions are loaded via Java SPI, see here for an example
• Available on Maven central, and the sources are in the 1.5.0-M1 branch. PRs should be submitted against the develop_2.0 branch.
• Please note that the swagger-core-1.5.x-M1 code lives in the 1.5.0-M1 branch.

Limitations:

• There will be a M2 and M3 release of swagger-core which will provide updated support for Play! framework and scala-based servers. Please see the github milestones page for details
• Subresource support is not implemented
• Model converters have a new, incompatible signature with 1.3.x. Please see here for an example for details of the new interface

swagger-core 1.3.10 is now available!

We're happy to announce the release of swagger-core 1.3.10!

Changes in this release:
Fixed broken artifact for swagger-play2 for scala 2.10 and 2.11

swagger-core 1.3.9 is now available!

We're happy to announce the release of swagger-core 1.3.9!

Changes in this release:
updated to swagger-ui 2.0.24
#667 fixed authorizations in 1.3.8
#633 added hidden=true support for @Api operations
#663 added scanning of interfaces with @Inherited annotation

Also, support for scala 2.9.x has been dropped, and the Play module support is 2.3.x and greater.