This monorepo contains tools for fixing and improving the official OpenAPI definition. The fixed OpenAPI definition can be found in the fixed--open-api.yml file.
Module | Description |
---|---|
json-utils | Utility classes for JSON/YAML |
-web-api-open-api | Apply the fixes and improvements to the official OpenAPI definition |
Unfortunately does not provide any version information with their Web API reference documentation. Therefore, I do not follow semantic versioning when releasing new versions. Version do follow a schema based on the release date: <year>.<month>.<day>
(e.g. a version released on 30th March 2021 will get the version number 2021.3.30
).
Because the documentation are only based on the Web API Reference, there might be difference to the actual behaviour of the Web API. Also, neither do I have any connections to nor am I an employee at .
Just start the Release workflow in Actions or perform the following steps manually
- Update the version number with
./mvnw versions:set -DnewVersion="<version>" -DgenerateBackupPoms=false
- Run OpenApiGenerator to update the openapi definition with new version
- Commit and push changes to
- Wait till CI is green
- Tag and push the commit created in step 1. A actions workflow will automatically deploy the artifacts to Maven Central.