Skip to content

Releases: SMILEY4/ktor-swagger-ui

3.2.0

11 Jul 15:35
Compare
Choose a tag to compare
  • fixed bug: security examples not generated with correct type
  • quality of life improvements to dsl
    • get("example", {
        tags = listOf("tag1", "tag2")
        // new alternative (also available for other collection setters):
        tags("tag1", "tag2")
      }) {}
    • get("example", {
        response {
          HttpStatusCode.OK to { /*...*/}
          // new alternative:
          code(HttpStatusCode.OK) { /*...*/ }
        }
      }) {}

3.1.0

28 Jun 16:01
Compare
Choose a tag to compare
  • add option to customize schema encoding

3.0.1

22 Jun 10:32
Compare
Choose a tag to compare
  • fixed body of defaultUnauthorizedResponse
  • upgraded schema-kenerator from 1.0.0 to 1.0.1

2.10.1

21 Jun 18:33
Compare
Choose a tag to compare

fixd bug: routes with same "url" not added to spec when rootHost-path is configured

3.0.0

09 Jun 11:39
Compare
Choose a tag to compare
  • improved default schema-generator configuration
  • improved documentation

Changes from 3.0.0-beta1

  • reworked schema and example handling; replaced previously used json schema generator with https://github.com/SMILEY4/schema-kenerator
    this switch should result in more predictable behavior, cleaner schemas in the spec and allow for more flexibility and better support for future features and bugfixes specific to the ktor-swagger-ui plugin

  • dropped automatic swagger-ui routing. Routes for swagger-ui and the openapi-file have to be added manually at the desired url
    this change should make the routing of the ui and spec more visible and intuitive while also allowing for easier customization of the routes

  • cleaned up plugin-configuration and openapi-dsl
    removed no longer necessary configuration and cleaned up existing groups making the plugin config a bit cleaner

  • examples are no longer part of the tests and have been moved to an own subproject. Reworked examples to better showcase functionalities.

Changes from 3.0.0-beta2

Changes from 3.0.0-beta3

  • add option to disable syntax highlighting (SwaggerUiSyntaxHighlight#DISABLED)
  • upgrade schema-kenerator to version 0.4.0 (https://github.com/SMILEY4/schema-kenerator/releases/tag/0.4.0)
  • uprade swagger-ui webjars to version 5.17.11
  • upgrade to openapi version 3.1.0 and add support for more properties
    • added info.summary
    • added license.identifier
    • added server.variables
    • added header.explode
    • added parameter.style
    • added route.externalDocs, route.servers
  • fix: swagger routing config

3.0.0-beta3

31 May 14:10
Compare
Choose a tag to compare
3.0.0-beta3 Pre-release
Pre-release
  • add option to disable syntax highlighting (SwaggerUiSyntaxHighlight#DISABLED)
  • upgrade schema-kenerator to version 0.4.0 (https://github.com/SMILEY4/schema-kenerator/releases/tag/0.4.0)
  • uprade swagger-ui webjars to version 5.17.11
  • upgrade to openapi version 3.1.0 and add support for more properties
    • added info.summary
    • added license.identifier
    • added server.variables
    • added header.explode
    • added parameter.style
    • added route.externalDocs, route.servers
  • fix: swagger routing config

3.0.0-beta2

20 May 18:28
Compare
Choose a tag to compare
3.0.0-beta2 Pre-release
Pre-release

3.0.0-beta1

19 May 16:11
Compare
Choose a tag to compare
3.0.0-beta1 Pre-release
Pre-release
  • reworked schema and example handling; replaced previously used json schema generator with https://github.com/SMILEY4/schema-kenerator
    this switch should result in more predictable behavior, cleaner schemas in the spec and allow for more flexibility and better support for future features and bugfixes specific to the ktor-swagger-ui plugin

  • dropped automatic swagger-ui routing. Routes for swagger-ui and the openapi-file have to be added manually at the desired url
    this change should make the routing of the ui and spec more visible and intuitive while also allowing for easier customization of the routes

  • cleaned up plugin-configuration and openapi-dsl
    removed no longer necessary configuration and cleaned up existing groups making the plugin config a bit cleaner

  • examples are no longer part of the tests and have been moved to an own subproject. Reworked examples to better showcase functionalities.

2.10.0

19 May 16:04
Compare
Choose a tag to compare

2.9.0

25 Apr 21:21
Compare
Choose a tag to compare
  • added option to manually configure routing for swagger-ui and api-spec-json
  • added (back) jackson-module - results in jackson annotation and sub-types being detected automatically again