Provide Karpenter full OpenAPI CRD Specs in docs

[jonathan-innis]

Is an existing page relevant?

Currently, there is not full documentation around the OpenAPI3 spec which Karpenter uses for its CRDs in the docs. If certain fields are not well-documented or there is ambiguity around what the type is for a particular field, users are forced to go to our code to find this info.

What karpenter features are relevant?

Overall usability

How should the docs be improved?

Document OpenAPI spec with auto-generated docs similar to how FluxCD does OpenAPI documentation

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

[jonathan-innis]

For Flux, OpenAPI docs are generated here in the Makefile. Flux uses https://github.com/ahmetb/gen-crd-api-reference-docs to generate their reference documentation