docs: Add information about "duration" API parameter #32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kubevirt-bot
added
release-note-none
|
/cc @0xFelix |
jcanocan
reviewed
Oct 11, 2023
| @@ -10,7 +10,14 @@ Where `${VMI_NAMESPACE}` and `${VMI_NAME}` are the namespace | |||
| and name of a running VMI. | |||
|
|
|||
| #### Parameters | |||
| - `duration` - Duration while the token is valid | |||
| - `duration` - Duration while the token is valid. If it is not specified, then the token will expire after 10 minutes. | |||
There was a problem hiding this comment.
Suggested change
| - `duration` - Duration while the token is valid. If it is not specified, then the token will expire after 10 minutes. | |
| - `duration` - Time in which the token is valid. If it is not specified, then the token will expire after 10 minutes. |
Feel free to reword my suggestion. But in any case, I find a bit redundant to define "duration" starting with the word "duration".
There was a problem hiding this comment.
I think that wording "Time in which" is unclear if it is a specific time moment, or a duration.
|
[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 |
kubevirt-bot
added
the
approved
|
I will change one thing. |
kubevirt-bot
added
the
do-not-merge/hold
akrejcir
force-pushed
the
duration-doc
branch
2 times, most recently
from
7a54b7b to
9a562bc
Compare
|
/unhold |
kubevirt-bot
removed
the
do-not-merge/hold
Added more information about the "duration" parameter. Signed-off-by: Andrej Krejcir <akrejcir@redhat.com>
akrejcir
force-pushed
the
duration-doc
branch
from
9a562bc to
6076e79
Compare
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Added more information about the
durationparameter.Release note: