Skip to content

Changelog

Lukas Ruegner edited this page May 29, 2023 · 27 revisions

2.0.0

  • improved automatic schema handling
  • changes in plugin-configuration
    • removed canonicalNameObjectRefs, schemasInComponentSection, examplesInComponentSection, jsonSchemaBuilder
    • replaced automaticTagGenerator with generateTags
    • added encoding-section
  • schema and example generation process more extendable (via encoding-config section) allowing for simpler integration of other schema-generators and json-serializers (e.g. supporting kotlinx and multiplatform) - see KotlinxExample.kt
  • print exceptions thrown during api generation

1.6.1

  • upgrade swagger parser to 2.1.13 due to vulnerabilities

1.6.0

  • add @Example-Annotation to add example values directly on fields of the model
  • support for (some features of) the openapi-core @Schema-Annotation

1.5.0

  • added "hidden"-flag to not include routes in openapi-spec

1.4.0

  • add (basic) support for swagger @Schema-annotation to add more information (mainly description, title, required, nullable) to schemas/fields

1.3.2

  • fix bug: primitive body types (int, float, ...) default to type "string" when specified via generics

1.3.1

  • fix bug: example values for parameters could not be set and were mixed up with the "explode"-option

1.3.0

  • allow multiple security schemes per route

1.2.0

  • add config (ignoredRouteSelectors) to ignore specific ktor route-selectors
  • enable usage of custom object schemas as object or array
  • add option to mark routes as deprecated
  • bugfix: changed canonicalNameObjectRefs in plugin-config from val to var

1.1.1

  • fix bug: changed canonicalNameObjectRefs to var in plugin-config

1.1.0

  • use simpleName instead of canonicalName for objects by default, can be configured via canonicalNameObjectRefs
  • upgrade to ktor 2.2.2
  • bugfix: fixed "operationsSorter"-value

1.0.2

  • fix bug: json-schemas for maps were not generated correctly

1.0.1

  • exclude documented-route from route-string

1.0.0

🥳

0.9.0

  • make json-schema-generator configurable
  • upgrade to ktor 2.2.1

0.8.0

  • add (basic) support for multipart-bodies

0.7.0

  • add additional configuration-options for swagger-ui
  • fix: add missing enum mapping for schemas

0.6.0

  • added support for custom predefined schemas
  • added support for custom json-schema-builders

0.5.2

  • fixed bug: configured rootPath (in application.conf) not respected

0.5.1

  • fixed bug: security scheme not added to openapi-spec

0.5.0

  • add @DslMarker for more safety
  • protect Swagger-UI and OpenApi-json with custom authentication
  • improved/proper support for generics in schemas (e.g. body<MyResponse>() as alternative to body(MyResponse::class))
  • support external json-schemas for bodies
  • support for default responses and responses for custom status-codes
  • support operationId
Clone this wiki locally