Skip to content

Releases: tabilzad/ktor-docs-plugin

v0.6.4-alpha

03 Oct 22:01
Compare
Choose a tag to compare

What's Changed

  • Add support for kotlin 2.0.20
  • Fix pulling annotations automatically if the plugin is applied

Known Bugs

  • KDocs are not included for external modules

Full Changelog: v0.6.3-alpha...v0.6.4-alpha

v0.6.3-alpha

19 Sep 14:03
089fc42
Compare
Choose a tag to compare

What's Changed

  • Derive schema/property descriptions from KDocs by default by @tabilzad in #25

Full Changelog: v0.6.2-alpha...v0.6.3-alpha

v0.6.2-alpha

21 Aug 00:06
Compare
Choose a tag to compare

What's Changed

  • Add Ktor Resources Support by @tabilzad in #21
  • Add support for type safe ktor dsl with explicit body type specification.
  • Parse custom serial names of kotlinx Serializable classes
  • Fix route level tags

Full Changelog: v0.6.1-alpha...v0.6.2-alpha

v0.6.1-alpha

18 Aug 19:03
Compare
Choose a tag to compare

What's Changed

  • Compute the OpenAPI file output path in KtorMetaPlugin and use its pr… by @donfreiday in #19
  • Parse Moshi @Json annotated property names by @donfreiday in #20

New Contributors

Full Changelog: v0.6.0-alpha...v0.6.1-alpha

v0.6.0-alpha

13 Aug 02:41
Compare
Choose a tag to compare

What's Changed

Add support for Kotlin 2.0 (K2)

  • Move annotations to io.github.tabilzad.ktor.annotations (will be published as a separate artifact)
    • Deprecate @KtorDocs in favor of @GenerateOpenApi
  • Derive field requirement from its type nullability by default
    • Explicit indication via @KtorFieldDescription overrides this per field
  • Add support for sealed classes
  • Add support for schema references with generic types
  • Amend @KtorDescription target to functions and expressions only
  • Add @KtorFieldDescription with RUNTIME retention to support schemas defined in external modules.
  • Add @Tag annotation
  • Remove arrow-meta

Note: K1 compiler (kotlin <1.9.x) will not be receiving new features/updates.

Full Changelog: v0.5.4-alpha...v0.6.0-alpha

v0.5.4-alpha

02 May 18:38
Compare
Choose a tag to compare
  • saveInBuild option will save the spec file under /build/resources/main/openapi instead of /build/openapi/

Full Changelog: v0.5.3-alpha...v0.5.4-alpha

v0.5.3-alpha

22 Apr 20:34
Compare
Choose a tag to compare

Full Changelog: v0.5.2-alpha...v0.5.3-alpha

  • Fix absent tags on Route extension functions (#7)

v0.5.2-alpha

01 Apr 03:33
Compare
Choose a tag to compare
  • Generate OpenApi spec 3.1.0
    • This version makes it possible to define polymorphic schema definitions (which will add support for in a later release)
  • Generate YAML by default
  • Add explicit annotation for definitions of response schemas and http codes
  • add flag to save openapi.yaml to the /build directory
  • Add ability to tag individual endpoints or the entire set of routes.
    • @Ktor(tags=["tag1"]) or @KtorDescription(tags=["tag2"]).
  • Add support for resolving endpoint query parameters defined by Enums or constants
  • Add configurations for ignoring private/internal or @Transient fields
  • Fixes several bugs resulting in schema's not having all its properties listed.
  • Sort schemas alphabetically by fq name.

v0.3.0-alpha

21 Dec 17:34
Compare
Choose a tag to compare
  • Generate OpenApi spec 3.0
  • Support for query params
  • Support for field and endpoint descriptions
  • Ignore @Transient fields
  • Bug fixes