search

projectsyn / lieutenant-api

The Project Syn Kubernetes Cluster and Tenants Inventory API
https://docs.syn.tools/lieutenant-api/
BSD 3-Clause "New" or "Revised" License
9 stars 1 forks source link

Update module github.com/getkin/kin-openapi to v0.98.0 #180

Closed renovate[bot] closed 2 years ago

renovate[bot] commented 2 years ago

Mend Renovate

This PR contains the following updates:

Package Type Update Change
github.com/getkin/kin-openapi require minor v0.94.0 -> v0.98.0

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

â™» Rebasing: Renovate will not automatically rebase this PR, because other commits have been found.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

This PR has been generated by Mend Renovate. View repository job log here.

glrf commented 2 years ago

We remove the GitRepo Type default from the specification.

Our OpenAPI validation library added support for default values. This includes a feature/bug that fails the validation if defaults are set for merge-patch+json requests.

We currently define a GitRepo type default of auto . This is defined across all requests and responses. However this is arguably wrong for patches. When patching a resource we generally don't want to set default as this will lead to unexpected results (i.e. reverting to the default if we do not explicitly set it to the current value in the patch)

For this reason (and to fix the validation error) we remove the GitRepo type default from the specification.

The "more correct" solution would probably be to keep the default and add a different specification without the default for patch operations, but that would make the OpenAPI specification a lot harder to maintain, so I opted for the technically wrong solution.