Document the validation limits within the API

[robscott]

What would you like to be added:
Throughout the API we have a number of validations such as min and max length. We should include some centralized documentation that covers these limits.

Why this is needed:
These limits are unfortunately not documented anywhere, and it can result in confusion when users run into them.

[robscott]

/triage accepted
/help

[k8s-ci-robot]

@robscott:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/triage accepted
/help

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.

[jgao1025]

Hi @robscott , I would love to work on this. TBH I am really new, but all the new folk friendly ones have been assigned and this one looks like the easiest to me.

[abhayakyy]

/assign

[youngnick]

Great to see some interest in this one, but I think the action to take here is probably going to need to be something that parses the Go types (or the CRD spec YAMLs that are generated from them), pulls out the validation limits, and generates a reference page (or adds to the existing reference page somehow).

Any manually-created thing is inevitably going to fall out of date.

[abhayakyy]

@robscott @shaneutt
Where should the documentation be put ?
Also any advice on format , how should it be created ?

[abhayakyy]

@youngnick thanks for the insight , can you please guide me further

[shaneutt]

I would say worry about getting the content somewhere that makes sense to you and then keep it simple to move it as needed as we progress. Thanks for taking this one on @abhayakyy!

[darshansreenivas]

/assign

[youngnick]

Actually, as of #3703 if not before, we've switched to a new CRD docs generator that now includes limitations in the Reference pages on the site - for example, check the live docs here https://gateway-api.sigs.k8s.io/reference/spec/#gatewayspec.

Sorry @darshansreenivas, I think that this one is already done! Thanks very much for volunteering to fix it.

I'll close it to prevent this sort of thing happening again.

/close

[k8s-ci-robot]

@youngnick: Closing this issue.

In response to this:

Actually, as of #3703 if not before, we've switched to a new CRD docs generator that now includes limitations in the Reference pages on the site - for example, check the live docs here https://gateway-api.sigs.k8s.io/reference/spec/#gatewayspec.

Sorry @darshansreenivas, I think that this one is already done! Thanks very much for volunteering to fix it.

I'll close it to prevent this sort of thing happening again.

/close

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.