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

📖 use generated RuntimeSDK schema YAML #6838

Merged
merged 1 commit into from
Jul 6, 2022
Merged

📖 use generated RuntimeSDK schema YAML #6838

merged 1 commit into from
Jul 6, 2022

Conversation

sbueringer
Copy link
Member

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #6795

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 6, 2022
@sbueringer sbueringer changed the title 📖 use generated RuntimeSDK schema YAML [WIP] 📖 use generated RuntimeSDK schema YAML Jul 6, 2022
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 6, 2022
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 6, 2022
@sbueringer sbueringer force-pushed the poc-gen-runtimesdk-yaml branch from 1fd46d0 to 8f8a851 Compare July 6, 2022 08:08
@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 Jul 6, 2022
@sbueringer sbueringer force-pushed the poc-gen-runtimesdk-yaml branch from 8f8a851 to f3b018b Compare July 6, 2022 08:27
sbueringer
sbueringer commented Jul 6, 2022
View reviewed changes
docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md
@@ -67,7 +67,7 @@ message: "error message if status == Failure"
retryAfterSeconds: 10
```

For additional details, refer to the [Draft OpenAPI spec](https://editor.swagger.io/?url=https://raw.githubusercontent.com/kubernetes-sigs/cluster-api/main/docs/proposals/images/runtime-hooks/runtime-hooks-openapi.yaml).
For additional details, you can see the full schema in <button onclick="openSwaggerUI()">Swagger UI</button>.
Copy link
Member Author

Choose a reason for hiding this comment

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

Okay so it looks like this works :).

The issue I'm solving here is that we need the URL of the runtime-sdk-openapi.yaml of the current book.
The button just calculates that URL and opens the Swagger UI with it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Demo can be seen under:

Copy link
Contributor

Choose a reason for hiding this comment

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

Very fancy 🙂

Copy link
Member Author

@sbueringer sbueringer Jul 6, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

You know the feeling when you're kind of proud of a very bad hack you made work? 😂

@sbueringer sbueringer force-pushed the poc-gen-runtimesdk-yaml branch from f3b018b to 69326aa Compare July 6, 2022 08:30
@sbueringer sbueringer changed the title [WIP] 📖 use generated RuntimeSDK schema YAML 📖 use generated RuntimeSDK schema YAML Jul 6, 2022
@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 Jul 6, 2022
@sbueringer sbueringer force-pushed the poc-gen-runtimesdk-yaml branch from 69326aa to dc7089a Compare July 6, 2022 08:33
killianmuldoon
killianmuldoon approved these changes Jul 6, 2022
View reviewed changes
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/lgtm

Let's make sure this works once it's in the main book.

docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md
@@ -67,7 +67,7 @@ message: "error message if status == Failure"
retryAfterSeconds: 10
```

For additional details, refer to the [Draft OpenAPI spec](https://editor.swagger.io/?url=https://raw.githubusercontent.com/kubernetes-sigs/cluster-api/main/docs/proposals/images/runtime-hooks/runtime-hooks-openapi.yaml).
For additional details, you can see the full schema in <button onclick="openSwaggerUI()">Swagger UI</button>.
Copy link
Contributor

Choose a reason for hiding this comment

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

Very fancy 🙂

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 6, 2022
@chrischdi
Copy link
Member

/lgtm

@sbueringer seems you're getting to the next level regarding netlify docs 😂

vincepri
vincepri approved these changes Jul 6, 2022
View reviewed changes
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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 Jul 6, 2022
@k8s-ci-robot k8s-ci-robot merged commit 9f50459 into kubernetes-sigs:main Jul 6, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Jul 6, 2022
@sbueringer
Copy link
Member Author

/cherry-pick release-1.2

@sbueringer sbueringer deleted the poc-gen-runtimesdk-yaml branch July 7, 2022 05:44
@k8s-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Jul 7, 2022
Merged
@k8s-infra-cherrypick-robot
Copy link

@sbueringer: new pull request created: #6851

In response to this:

/cherry-pick release-1.2

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/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@killianmuldoon killianmuldoon killianmuldoon approved these changes

@vincepri vincepri vincepri approved these changes

@JoelSpeed JoelSpeed Awaiting requested review from JoelSpeed

Assignees

@chrischdi chrischdi

@killianmuldoon killianmuldoon

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v1.3
Development

Successfully merging this pull request may close these issues.

RuntimeSDK: reference generated OpenAPI specs in the documentation
6 participants
@sbueringer @chrischdi @k8s-ci-robot @k8s-infra-cherrypick-robot @vincepri @killianmuldoon