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.

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

doc: Add API example to documentation #11

Merged
merged 1 commit into from
Mar 17, 2023

Conversation

akrejcir
Copy link
Collaborator

What this PR does / why we need it:

  • Moved API documentation to a separate file.
  • Added examples how to call the API.

Release note:

None

@kubevirt-bot kubevirt-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. labels Mar 15, 2023
@kubevirt-bot kubevirt-bot requested review from 0xFelix and ksimon1 March 15, 2023 15:14
@akrejcir
Copy link
Collaborator Author

/cc @0xFelix @codingben

@kubevirt-bot kubevirt-bot requested a review from codingben March 15, 2023 15:15
@akrejcir
Copy link
Collaborator Author

CI is not needed for this PR.

/override ci/prow/images

@kubevirt-bot
Copy link
Contributor

@akrejcir: Overrode contexts on behalf of akrejcir: ci/prow/images

In response to this:

CI is not needed for this PR.

/override ci/prow/images

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.

The `KUBERNETES_USER_TOKEN` variable is a bearer token used to authenticate with
kubernetes API. It can be obtained using:
```bash
KUBERNETES_USER_TOKEN=$(oc whoami -t)
Copy link
Member

Choose a reason for hiding this comment

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

Can you add an example on how to acquire a token with kubectl too?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm not sure there is a simple command to do that using kubectl.

Copy link
Member

Choose a reason for hiding this comment

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

Unfortunately, I'd love to see this also run on plain Kubernetes.

docs/api.md Show resolved Hide resolved
docs/api.md Outdated Show resolved Hide resolved
docs/api.md Outdated Show resolved Hide resolved
- Moved API documentation to a separate file.
- Added examples how to call the API.

Signed-off-by: Andrej Krejcir <akrejcir@redhat.com>
Copy link
Member

@codingben codingben left a comment

Choose a reason for hiding this comment

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

/lgtm

@kubevirt-bot kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Mar 16, 2023
Copy link
Member

@0xFelix 0xFelix left a comment

Choose a reason for hiding this comment

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

/approve

@kubevirt-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 0xFelix

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

@kubevirt-bot kubevirt-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 17, 2023
@kubevirt-bot kubevirt-bot merged commit 4581286 into kubevirt:main Mar 17, 2023
@akrejcir akrejcir deleted the add-api-example branch March 21, 2023 16:01
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. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants