Skip to content

Releases: ePages-de/restdocs-api-spec

Support attributes for ParameterDescriptor and HeaderDescriptor

22 Feb 10:02
728f7bd

Choose a tag to compare

Thanks to @iwaltgen for solving #95 with #200

  • Attributes map from ParameterDescriptor and HeaderDescriptor are retained when using ParameterDescriptorWithType and HeaderDescriptorWithType
  • This enables you to document a list of possible values (enumValues) for request parameters and headers
  • OpenAPI 2 and OpenAPI 3 generators consider those enumValues when generating JSON Schema

Add support for @Min @Max constraints to NumberSchema

15 Feb 08:05
775795a

Choose a tag to compare

0.15.3

feat: apply `@Min` `@Max` constraints to NumberSchema (#199)

JSON Schema: Fix default value support

06 Dec 09:38
27db748

Choose a tag to compare

Lint and build fix

24 Nov 10:08

Choose a tag to compare

0.15.0 failed build step with a linting error, CI wasn't run on #193

JSON Schema: Support @Pattern annotation

24 Nov 09:04
5ce9ec0

Choose a tag to compare

Thanks to @jervds for contributing #193 !

The value of @Pattern annotation/constraint for string fields is now propagated to the JSON Schema generated by restdocs-api-spec.

JSON Schema: fix schema for arrays and nested objects

29 Oct 16:16
1da4f1c

Choose a tag to compare

Thanks to @jgazeau for providing the fix #192

  • Fix JSON Schema for arrays and nested objects

Rename default to defaultValue

19 Oct 15:47
5b2f47b

Choose a tag to compare

Thanks to @taehioum for pointing out #190 :
The new default value support for Header- and ParameterDescriptors introduced with 0.12.0 and 0.13.0 was using default as field and property names. This is fine in Kotlin, this is an error in Java. This release should fix Java compatibility.

JSON Schema: Default values for HeaderDescriptor

15 Oct 09:28
fbaf003

Choose a tag to compare

Thanks to @jgazeau for this amendment to v0.12.0:

  • Support default values for HeaderDescriptors in JSON Schema generated by OpenAPI 2 and OpenAPI 3 generators, see #189

JSON Schema: Support default values and array items type

27 Aug 19:36
fe18455

Choose a tag to compare

Thanks to @jgazeau and @TiboStev for contributing the following changes:

JSON Schema: Fix Required and Size Constraints

16 Aug 09:22
@ooz ooz

Choose a tag to compare

Thanks to @TiboStev for fixing #90 #180 #172 with #183 :

  • Fix required constraints on fields
  • Fix required constraints on array fields
  • Fix size constraints on array fields