Skip to content

Fix API generation for v1.20 (rc.0) #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2020

Conversation

tengqm
Copy link
Contributor

@tengqm tengqm commented Dec 3, 2020

This PR fixes two problems in the API reference generator:

  1. The StorageVersion resource introduced in 1.20 is not a good citizen:
  • resource API version named: internal.apiserver.k8s.io
  • definition path in Swagger: io.k8s.api.apiserverinternal
  • operation ID defined as: createInternalApiserver...

Note that the two key words ("internal" and "apiserver") are in different orders; sometimes they split, other times they are merged.

  1. The following APIs are not RESTful APIs because they are not associated with any REST resources. These two APIs have to be skipped.
  • getServiceAccountIssuerOpenIDConfiguration exposed at /.well-known/openid-configuration/;
  • getServiceAccountIssuerOpenIDKeyset exposed at /openid/v1/jwks.

closes: #178

The StorageVersion resource introduced is not a good citizen:

- resource API version named: `internal.apiserver.k8s.io`
- definition path in Swagger: `io.k8s.api.apiserverinternal`
- operation ID defined as: `createInternalApiserver...`

That is, the two key words ("internal" and "apiserver") are in different
order; sometimes they split, other times they are merged.

The following APIs are not RESTful APIs because they are not associated
with any REST resources. These two APIs have to be skipped.

- `getServiceAccountIssuerOpenIDConfiguration` exposed at
  `/.well-known/openid-configuration/`;
- `getServiceAccountIssuerOpenIDKeyset` exposed at `/openid/v1/jwks`.
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 3, 2020
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 3, 2020
@kbhawkey
Copy link
Contributor

kbhawkey commented Dec 3, 2020

Changes look good.
What about logging an issue in kubernetes/kubernetes?
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 3, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kbhawkey, tengqm

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot merged commit 18019ca into kubernetes-sigs:master Dec 3, 2020
@tengqm tengqm deleted the fix-v120-api branch December 4, 2020 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update API reference generator for 1.20 release
3 participants