Releases: ePages-de/restdocs-api-spec
Fix JSON Schema for required properties of type 'object'
Publish gradle plugin
3rd attempt with proper configuration of Gradle plugins portal credentials via environment variables (for TravisCI).
Publish gradle plugin, 2nd attempt
...with slightly changed TravisCI config.
Publish gradle plugin
No changes, just a separate tag/release to test publishing to gradle plugins portal.
Special thanks to @chadlwilson for providing the PR + lots of patience!
Deterministic snippet names and content-type parameters
- If multiple examples for the same request (same HTTP method, path and content type) are provided, the common snippet ID is now generated in a deterministic fashion, see #141 for details
- Add support for content-type parameters thanks to @CalamarBicefalo , see #142
Bump swagger-core version to fix YAML serialization of HTTP response status codes
Fix OpenAPI 2.0 + 3.0 generation considering application/x-www-form-urlencoded request bodies
Thanks to @afronski fixing #113 , restdocs-api-spec now properly supports application/x-www-form-urlencoded
request bodies:
- Spring
ParameterDescriptor
s may be used to document request fields - Form data fields are now correctly rendered for OpenAPI 2.0 and 3.0 (see https://swagger.io/docs/specification/2-0/describing-parameters/#form-parameters and https://swagger.io/docs/specification/describing-request-body/ respectively)
- The schema derived from form data requests should now be correct for OpenAPI 3.0
Fix multiple path parameters in same request URL segment
Fixing #115 thanks to @Sushruth-Godugunuari #135 , so it is now possible to document request URLs like
/resource-{param}-{anotherParam}
and have both path parameters detected. The fix applies to both OpenAPI 2 and OpenAPI 3 generators.
Enum support for request/response fields
Possible enum values may now expressed for request/response fields in api-spec and rendered by the OpenAPI 2 and OpenAPI 3 gradle plugins. See #127 and linked issues/PRs for details and restrictions (e.g. possible enum values in request URL parameters are not yet supported).
Custom schema name
Feature/78 control schema name (#126) * Add ability to set request / response schema name (cherry picked from commit 9880dd196c3077ed65319fb8cf7c6686d8d23ffd) * Validate schemaName in ResourceSnippetTest. * Introduce dedicated data structure for schema properties. * Add support for custom schema names in OpenApi3Generator * Add test which ensures that different schema names result in different schemas in OpenApi3Generator. * Simplified expression for schema generation in OpenApi3Generator. * Add support for custom schema names in OpenApi20Generator. * Moved schema to ResourceSnippetParameters. * Add @JvmStatic to Schema companion object. * Removed unnecessary semicolons * Fixed wildcard imports * Fixed further lint errors. Co-authored-by: Oleksandr Abasov <[email protected]>