Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs for OpenAPI v3 #30534

Merged
merged 1 commit into from
Nov 30, 2021
Merged

Docs for OpenAPI v3 #30534

merged 1 commit into from
Nov 30, 2021

Conversation

Jefftree
Copy link
Member

@Jefftree Jefftree commented Nov 17, 2021 •
edited
Loading

Add section for OpenAPI V3

@k8s-ci-robot k8s-ci-robot added this to the 1.23 milestone Nov 17, 2021
@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 17, 2021
@netlify
Copy link

netlify bot commented Nov 17, 2021 •
edited
Loading

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

🔨 Explore the source changes: 4154709

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/61a663f95b412b00098158fc

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 17, 2021
@Jefftree Jefftree mentioned this pull request Nov 17, 2021
Closed
13 tasks
@jlbutler
Copy link
Contributor

/assign

@jlbutler
Copy link
Contributor

@Jefftree Reminder that tomorrow Nov 23rd is the deadline for 1.23 Docs Ready for Review. Please push your docs content for this enhancement and remove the work-in-progress label when ready for review.

We have a tight turnaround to getting docs reviewed and approved for the release, and we're hoping to have all docs in for review by EOB tomorrow. Thank you!

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 23, 2021
@Jefftree Jefftree changed the title [WIP] Docs for OpenAPI v3 Docs for OpenAPI v3 Nov 24, 2021
@Jefftree Jefftree marked this pull request as ready for review November 24, 2021 19:34
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 24, 2021
@sftim
Copy link
Contributor

sftim commented Nov 24, 2021

/sig api-machinery
/wg api-expression

@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. wg/api-expression Categorizes an issue or PR as relevant to WG API Expression. labels Nov 24, 2021
@sftim
Copy link
Contributor

sftim commented Nov 24, 2021

@Jefftree would you be willing to squash commits? One of your commit messages is “Placeholder”.

sftim
sftim reviewed Nov 24, 2021
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This'll need tech review from SIG API Machinery (which, I hope, will be a formality only).

Also I spotted some potential improvements.

content/en/docs/concepts/overview/kubernetes-api.md Outdated Show resolved Hide resolved
content/en/docs/concepts/overview/kubernetes-api.md Outdated Show resolved Hide resolved
@jlbutler
Copy link
Contributor

@Jefftree The 'docs ready' deadline for 1.23 is tomorrow Nov 30. Can you please check out the recent comments from Tim, as well as land a tech reviewer for this PR? Thanks!

@sftim
Copy link
Contributor

sftim commented Nov 30, 2021

LGTM for SIG Docs

@kubernetes/sig-api-machinery-pr-reviews happy with technical accuracy for this PR?

apelisse
apelisse reviewed Nov 30, 2021
View reviewed changes
Copy link
Member

@apelisse apelisse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small clarification, but lgtm otherwise.

content/en/docs/concepts/overview/kubernetes-api.md
</tbody>
</table>

A discovery endpoint `/openapi/v3` is provided to see a list of all
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this accepting the same content-type as above? Or only json?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Updated to state that it only returns JSON.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 30, 2021
@apelisse
Copy link
Member

/lgtm

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

LGTM label has been added.

Git tree hash: 2c24c5017260472fdbd0f7e8066729e8ae665ab7

@jlbutler
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jlbutler

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 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 30, 2021
@k8s-ci-robot k8s-ci-robot merged commit de9e3fe into kubernetes:dev-1.23 Nov 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@apelisse apelisse apelisse left review comments

@sftim sftim sftim left review comments

Assignees

@apelisse apelisse

@jlbutler jlbutler

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. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. wg/api-expression Categorizes an issue or PR as relevant to WG API Expression.
Projects
None yet
Milestone
1.23
Development

Successfully merging this pull request may close these issues.
5 participants
@Jefftree @jlbutler @sftim @apelisse @k8s-ci-robot