VaporOpenAPI

MIT License

Stars
57

Bot releases are visible (Hide)

VaporOpenAPI - Update for newest Vapor version Latest Release

Published by mattpolzin 12 months ago

This fixes things for Vapor version 4.86.0 but since these are breaking changes it also requires at least Vapor 4.86.0 now.

VaporOpenAPI - Now produces OpenAPI 3.1 documentation

Published by mattpolzin 12 months ago

VaporOpenAPI - Adds operation deprecation.

Published by mattpolzin over 1 year ago

What's Changed

VaporOpenAPI - Adds ability to specify when query parameters are required or deprecated

Published by mattpolzin almost 2 years ago

Thanks to @TimAEllis for adding support for two more OpenAPI properties of query parameters: required and deprecated.

VaporOpenAPI - Support for Vapor-configured JSON encoder.

Published by mattpolzin about 2 years ago

This PR removes the need for always creating or specifying a JSON encoder by instead supporting a default based on Vapor's default.

Thanks to @tetraoxygen for this improvement!

VaporOpenAPI - Async/await support

Published by mattpolzin about 2 years ago

Thanks to @tetraoxygen for adding support for async/await and for adding a lot of code documentation!

VaporOpenAPI - Better fix for all empty response bodies

Published by mattpolzin about 3 years ago

Thanks for @JaapWijnen for a fix that applies to the OpenAPI documentation generation for any status code that might have an empty response body associated with it.

VaporOpenAPI - Fix lack of OpenAPI response generation for No Content responses

Published by mattpolzin about 3 years ago

Responses with the status code 204 (No Content) were not being turned into OpenAPI responses properly.

VaporOpenAPI - Test for empty response body DELETE endpoint.

Published by mattpolzin about 3 years ago

This is not really worth of a new release; it does force the VaporTypedResponse update from 0.7.0 to 0.7.1 which is where the new encodeEmptyResponse() method comes from.

VaporOpenAPI - More appropriate OpenAPI type for CSV query parameters

Published by mattpolzin over 3 years ago

VaporOpenAPI - Update for OpenAPIKit v2

Published by mattpolzin about 4 years ago

Note that OpenAPIKit v2 introduces some breaking changes.

VaporOpenAPI - Update to OpenAPIKit v1.0

Published by mattpolzin over 4 years ago

⚠️ Breaking Changes ⚠️
OpenAPIKit v1.0 comes with some breaking changes, although now OpenAPIKit will be stable for the duration of the v1 major version.

VaporOpenAPI - Fix path param description when unspecified.

Published by mattpolzin over 4 years ago

report an unspecified description as nil instead of an empty string.

VaporOpenAPI - Improve upon path parameter support

Published by mattpolzin over 4 years ago

  • Add ability to specify the type of a path parameter.
  • Remove need to use a new RoutesBuilder replacement, which means you just use app.get/post/etc. to add routes to your app. This should also work with route groups.

⚠️ Breaking Changes ⚠️
Application.openAPI has been removed -- it was a RoutesBuilder replacement that is no longer needed. Anywhere you would have written app.openAPI.get(...) you can now write app.get(...).

VaporOpenAPI - Support JSON:API response schema guessing

Published by mattpolzin over 4 years ago

VaporOpenAPI - Add ability to add descriptions to path parameters.

Published by mattpolzin over 4 years ago

This feature comes with the addition of a new type of routes builder. If you want to add descriptions to path parameters, the route must be built with app.openAPI.get/post/etc. instead of app.get/post/etc. or app.routes.get/post/etc..

VaporOpenAPI - Bump VaporTypedRoutes version.

Published by mattpolzin over 4 years ago

⚠️ Breaking Change ⚠️
New version of VaporTypedRoutes adds a new requirement to RouteContext (although it is perfectly acceptable to just set the new static property to nil).

VaporOpenAPI - Update VaporTypedRoutes and Vapor

Published by mattpolzin over 4 years ago

Fixes a small breaking change made in Vapor 4.5.0

VaporOpenAPI - Update OpenAPIKit, move to requiring 4.x releases of Vapor.

Published by mattpolzin over 4 years ago

VaporOpenAPI - Update OpenAPIKit version

Published by mattpolzin over 4 years ago

⚠️ Breaking Changes ⚠️
OpenAPIKit has breaking changes across this version bump.