fix(oas): add required properties to api components

[evilhamsterman]

What does it do ?

Updates the OpenAPI schema to indicate required properties in the components

Motivation

Using the schema with a code generation tool, such as datamodel-codegen for Python Pydantic currently outputs models with all properties marked as optional. This does not match the types in the code.

More

• Yes, this PR title follows Conventional Commits
• Yes, I added unit tests
• Yes, I updated end user documentation accordingly

No tests or documentation required

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: evilhamsterman / name: Dan Mills (88bcb2a, 6086fc4)

[k8s-ci-robot]

Welcome @evilhamsterman!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/external-dns has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @evilhamsterman. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[ivankatliarchuk]

Something we need to automate. How python tool was used to generate yaml from go structs?

ref: #5110

[evilhamsterman]

I used a Python tool to generate Pydantic models from the OpenAPI spec. I just looked at the structs and the existing kubebuilder tags. Though while playing with it I realized those tags aren't entirely accurate not all requests include a setIdentifier or recordTTL so I removed those

[evilhamsterman]

There are generators that could be used. I could take a look at that if you want, though I can't guarantee when

On a semi related note, a POST to /records requests a 204 response. But 204 is No Content, wouldn't 202 Accepted be better?

[evilhamsterman]

Or maybe a better way is generate the Go code from the spec?

[ivankatliarchuk]

Or maybe a better way is generate the Go code from the spec?

This is a fundamental question in API development, and there are two main approaches: Design-First and Code-First. Both have their own advantages, and the choice depends on the project's specific needs. For project size like external-dns most likely code-first approach is just simpler, but no preference. The main goal, we should have a well defined process that we could iterate and improve.

Regardless of the solution, we need a Go unit test that will fail if there is any drift between the API YAML spec and the Go code.

Examples we have for:

• metrics https://github.com/kubernetes-sigs/external-dns/tree/master/internal/gen/docs/metrics
• supported flags https://github.com/kubernetes-sigs/external-dns/tree/master/internal/gen/docs/flags

Quite popular tool https://github.com/oapi-codegen/oapi-codegen

[evilhamsterman]

Yeah I was thinking about that, since the structs are part of the code else where it's probably better to generate API from the code rather than generate code from the API

[mloiseleur]

/ok-to-test

[mloiseleur]

This pr looks good and makes sense to me.
@evilhamsterman If you can help us to generate it from the go code, it would be great !

/lgtm

[ivankatliarchuk]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ivankatliarchuk

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [ivankatliarchuk]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment