Fix Quantity OpenAPI description formatting - #140135

The committers listed above are authorized under a signed CLA.

• ✅ login: Dricmoy / name: Dricmoy (c1528b6)

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Welcome @Dricmoy!

It looks like this is your first PR to kubernetes/kubernetes 🎉. 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/kubernetes 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. 😃

Hi @Dricmoy. Thanks for your PR.

I'm waiting for a kubernetes 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.

This PR may require API review.

If so, when the changes are ready, complete the pre-review checklist and request an API review.

Status of requested reviews is tracked in the API Review project.

This PR does not change Kubernetes API semantics, wire format, validation, defaulting, versioned types, fields, flags, or behavior. It only updates the Quantity doc comment and refreshed generated OpenAPI/protobuf/testdata descriptions so the existing OpenAPI description renders as valid CommonMark.

The kind/api-change label seems to have been added because generated OpenAPI files changed. Could a reviewer confirm whether API review is actually required here? If not, could a member remove kind/api-change and proceed with triage / ok-to-test?

This reads way nicer than the old code block

small nit: the old <...> made it obvious which words pointed to other rules vs. which were literals. Now everything's backticked the same, so in `suffix`: `binarySI | decimalExponent | decimalSI` it's not clear that binarySI is the rule below and not a literal. Maybe a quick note on the convention? Not a blocker.

/ok-to-test

I believe the prerequisites for this have no merged. This is ready to be rebased.

Checking in again, @Dricmoy would you rebase this PR? We can merge after.

Thanks!

/lgtm
/approve

LGTM label has been added.

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Dricmoy, jpbetz

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

The pull request process is described here

@jpbetz hey thanks for tagging and reminding, rebased!

/retest-required