feat: kompendium 2.0.0 release!
This commit is contained in:
40
CHANGELOG.md
40
CHANGELOG.md
@ -1,10 +1,10 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## Unreleased
|
## Unreleased
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- Gradle refactor
|
|
||||||
|
|
||||||
### Remove
|
### Remove
|
||||||
|
|
||||||
@ -12,21 +12,19 @@
|
|||||||
|
|
||||||
## Released
|
## Released
|
||||||
|
|
||||||
## [2.0.0-beta] - January 12th, 2022
|
## [2.0.0] - January 23rd, 2022
|
||||||
|
|
||||||
|
Major Release 🎉 As we head towards the Ktor 2 release, this library will be kept compatible with Ktor 1. A future
|
||||||
|
Kompendium 2 repository will be created soon, porting much of the changes you see here, with some awesome Ktor 2 twists
|
||||||
|
😉
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Support for HTTP Patch, Head, and Options methods
|
- Support for HTTP Patch, Head, and Options methods
|
||||||
- Support for including parameter examples via `MethodInfo`
|
- Support for including parameter examples via `MethodInfo`
|
||||||
- Dokka Pipeline Generation
|
- Dokka Pipeline Generation
|
||||||
- GitHub Pages integration
|
- GitHub Pages integration
|
||||||
- Sourdough Gradle updates
|
- Sourdough Gradle updates
|
||||||
|
|
||||||
### Changed
|
|
||||||
- Kompendium now leverages the chosen API serializer. Supports Jackson, Gson and Kotlinx Serialization
|
|
||||||
- Fixed bug where overridden field names were not reflected in serialized object and required array
|
|
||||||
- Fixed bug where Ktor Location parents were not being scanned for parameters
|
|
||||||
|
|
||||||
## [2.0.0-alpha] - January 2nd, 2022
|
|
||||||
### Added
|
|
||||||
- Support for OAuth authentication
|
- Support for OAuth authentication
|
||||||
- Gradle Toolchain feature to ensure match between local JDK and compile target
|
- Gradle Toolchain feature to ensure match between local JDK and compile target
|
||||||
- Dokka integration
|
- Dokka integration
|
||||||
@ -36,6 +34,10 @@
|
|||||||
- Ability to document expected unstructured data
|
- Ability to document expected unstructured data
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
|
- Kompendium now leverages the chosen API serializer. Supports Jackson, Gson and Kotlinx Serialization
|
||||||
|
- Fixed bug where overridden field names were not reflected in serialized object and required array
|
||||||
|
- Fixed bug where Ktor Location parents were not being scanned for parameters
|
||||||
- `$ref` types are no longer generated, instead all objects are defined explicitly
|
- `$ref` types are no longer generated, instead all objects are defined explicitly
|
||||||
- All OpenAPI domain models moved to a separate module `kompendium-oas`
|
- All OpenAPI domain models moved to a separate module `kompendium-oas`
|
||||||
- Moved all files in `kompendium-core` into `io.bkbn.kompendium.core` package from `io.bkbn.kompendium`
|
- Moved all files in `kompendium-core` into `io.bkbn.kompendium.core` package from `io.bkbn.kompendium`
|
||||||
@ -43,7 +45,8 @@
|
|||||||
- Gradle build logic offloaded to Sourdough Plugin
|
- Gradle build logic offloaded to Sourdough Plugin
|
||||||
- Minimum supported Java version is now 11
|
- Minimum supported Java version is now 11
|
||||||
- Bumped Kotlin to 1.6
|
- Bumped Kotlin to 1.6
|
||||||
- Annotations now live in a separate module. (Should not impact end users as module is imported as api dependency by core).
|
- Annotations now live in a separate module. (Should not impact end users as module is imported as api dependency by
|
||||||
|
core).
|
||||||
- Kotest as the testing framework of choice
|
- Kotest as the testing framework of choice
|
||||||
- Path calculation removed in favor of built-in route toString
|
- Path calculation removed in favor of built-in route toString
|
||||||
- Ktor to 1.6.7
|
- Ktor to 1.6.7
|
||||||
@ -69,11 +72,15 @@
|
|||||||
- Dropped ASDF tool manifest
|
- Dropped ASDF tool manifest
|
||||||
|
|
||||||
## [1.11.1] - November 25th, 2021
|
## [1.11.1] - November 25th, 2021
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Documentation showing how to add header names using Kotlin backtick convention
|
- Documentation showing how to add header names using Kotlin backtick convention
|
||||||
|
|
||||||
## [1.11.0] - November 25th, 2021
|
## [1.11.0] - November 25th, 2021
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Support for Ktor Location Plugin
|
- Support for Ktor Location Plugin
|
||||||
|
|
||||||
## [1.10.0] - November 25th, 2021
|
## [1.10.0] - November 25th, 2021
|
||||||
@ -103,7 +110,6 @@
|
|||||||
|
|
||||||
- ByteArray added to the set of default types
|
- ByteArray added to the set of default types
|
||||||
|
|
||||||
|
|
||||||
## [1.8.1] - October 4th, 2021
|
## [1.8.1] - October 4th, 2021
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
@ -223,7 +229,7 @@ This is just to get my repo back to normal now that I have confirmed sonatype pu
|
|||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Support for example request and response bodies. Parameter examples / defaults are a separate issue for later.
|
- Support for example request and response bodies. Parameter examples / defaults are a separate issue for later.
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
@ -272,7 +278,8 @@ This is just to get my repo back to normal now that I have confirmed sonatype pu
|
|||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Added an explicit `PathCalculator` interface to allow for easier handling of routes external to the core set of Ktor route selectors.
|
- Added an explicit `PathCalculator` interface to allow for easier handling of routes external to the core set of Ktor
|
||||||
|
route selectors.
|
||||||
|
|
||||||
## [0.5.1] - April 19th, 2021
|
## [0.5.1] - April 19th, 2021
|
||||||
|
|
||||||
@ -363,12 +370,13 @@ This is just to get my repo back to normal now that I have confirmed sonatype pu
|
|||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Beginning of an implementation. Currently, able to generate a rough outline of the API at runtime, along with generating
|
- Beginning of an implementation. Currently, able to generate a rough outline of the API at runtime, along with
|
||||||
full data classes represented by JSON Schema.
|
generating full data classes represented by JSON Schema.
|
||||||
|
|
||||||
## [0.0.1] - April 11th, 2021
|
## [0.0.1] - April 11th, 2021
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Added _most_ of the data classes necessary for generating an [Open API Spec](https://swagger.io/specification)
|
- Added _most_ of the data classes necessary for generating an [Open API Spec](https://swagger.io/specification)
|
||||||
- Added playground to allow users to tinker with a live Ktor api in conjunction with development
|
- Added playground to allow users to tinker with a live Ktor api in conjunction with development
|
||||||
- Added all standard OSS files
|
- Added all standard OSS files
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
# Kompendium
|
# Kompendium
|
||||||
project.version=2.0.0-rc1
|
project.version=2.0.0
|
||||||
# Kotlin
|
# Kotlin
|
||||||
kotlin.code.style=official
|
kotlin.code.style=official
|
||||||
# Gradle
|
# Gradle
|
||||||
|
Reference in New Issue
Block a user