feat(webhook): initial OpenAPI spec #4874
Conversation
This needs far better descriptions, but provides the initial OpenAPI doc describing the webhook API as described in the code.
The vacuum run is now clean.
Explain some of the schemas and endpoints in more detail.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/L
| shell: bash | ||
| - name: Run Vacuum | ||
| run: | | ||
| go run github.com/daveshanley/vacuum@latest lint -d api/webhook.yaml |
There was a problem hiding this comment.
Can we pin this or use a specific pinned action?
| @@ -60,9 +60,12 @@ licensecheck: | |||
| exit 1; \ | |||
| fi | |||
|
|
|||
| oas-lint: | |||
| go run github.com/daveshanley/vacuum@latest lint -d api/webhook.yaml | |||
There was a problem hiding this comment.
Same for the pinning comment above.
| @@ -162,7 +162,6 @@ func TestAdjustEndpoints(t *testing.T) { | |||
| } | |||
| j, _ := json.Marshal(endpoints) | |||
| w.Write(j) | |||
|
|
|||
| --- | ||
| openapi: "3.0.0" | ||
| info: | ||
| version: 0.14.0 |
There was a problem hiding this comment.
Is this the ExternalDNS version? Do we want to add a v in front so that we can more easily find and replace it on release?
| @@ -0,0 +1,265 @@ | |||
| --- | |||
There was a problem hiding this comment.
Is this generated or written from scratch? I don't see us changing the webhook interface a lot, but how do we remember to keep it up to date in that case? Is it a manual operation?
| description: Endpoints to update DNS records. | ||
| servers: | ||
| - url: http://localhost:8888 | ||
| description: Server url for a k8s deployment. |
There was a problem hiding this comment.
Extreme nitpick, but for me it's better to always spell it Kubernetes, it is way more accessible to newcomers.
| description: Server url for a k8s deployment. | |
| description: Server url for a Kubernetes deployment. |
| - example.com | ||
| '500': | ||
| description: | | ||
| Failed to provide the list of domains we serve. |
There was a problem hiding this comment.
This is wrong, I think. We failed the negotiation at this point.
Description
This PR is based on #4148.
Checklist