Add docs for new API endpoints #3057
Merged
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
s-makin
reviewed
Apr 11, 2024
docs/references/api.rst
Outdated
| - Introduced in Ubuntu Pro Client Version: ``32~`` | ||
| - Args: | ||
|
|
||
| - ``token``: The token associated with a Pro subscriptionn |
There was a problem hiding this comment.
Suggested change
| - ``token``: The token associated with a Pro subscriptionn | |
| - ``token``: The token associated with a Pro subscription |
docs/references/api.rst
Outdated
| - The services enabled during the attach operation | ||
| * - ``reboot_required`` | ||
| - *bool* | ||
| - If the system requires a reboot after the attach operation |
There was a problem hiding this comment.
Presumably this is True if the system requires a reboot?
There was a problem hiding this comment.
Yes, I will make it more explicit
docs/references/api.rst
Outdated
|
|
||
| pro api u.pro.attach.token.full_token_attach.v1 | ||
|
|
||
| Note that we don't need to explicit pass the token when calling the CLI command. |
There was a problem hiding this comment.
Suggested change
| Note that we don't need to explicit pass the token when calling the CLI command. | |
| Note that we don't need to explicitly pass the token when calling the CLI command. |
docs/references/api.rst
Outdated
| pro api u.pro.attach.token.full_token_attach.v1 | ||
|
|
||
| Note that we don't need to explicit pass the token when calling the CLI command. | ||
| If we define a json file (i.e. file.json) with the same attributes as the options for this endpoint: |
There was a problem hiding this comment.
Suggested change
| If we define a json file (i.e. file.json) with the same attributes as the options for this endpoint: | |
| If we define a JSON file (i.e. ``file.json``) with the same attributes as the options for this endpoint: |
docs/references/api.rst
Outdated
| "auto_enable_services": false | ||
| } | ||
|
|
||
| Then, we can call the API like this: |
There was a problem hiding this comment.
Suggested change
| Then, we can call the API like this: | |
| Then we can call the API like this: |
docs/references/api.rst
Outdated
| - The services disabled during the detach operation | ||
| * - ``reboot_required`` | ||
| - *bool* | ||
| - If the system requires a reboot after the detach operation |
There was a problem hiding this comment.
Should this also be "True if..."
docs/references/api.rst
Outdated
| .. tab-item:: Explanation | ||
| :sync: explanation | ||
|
|
||
| The *contract_status* field can return 4 different states, they are: |
There was a problem hiding this comment.
Suggested change
| The *contract_status* field can return 4 different states, they are: | |
| The ``contract_status`` field can return 4 different states, they are: |
docs/references/api.rst
Outdated
Comment on lines
2392
to
2393
| * **grace-period**: The contract is in the grace period. This means that it is expired, | ||
| there are still some days were the contract will be valid. |
There was a problem hiding this comment.
Suggested change
| * **grace-period**: The contract is in the grace period. This means that it is expired, | |
| there are still some days were the contract will be valid. | |
| * **grace-period**: The contract is in the grace period. This means that it is expired, | |
| but there are still some days where the contract will be valid. |
lucasmoura
force-pushed
the
new-api-docs
branch
from
fca8e6e
to
327a992
Compare
|
@s-makin updated |
s-makin
approved these changes
Apr 11, 2024
docs/references/api.rst
Outdated
| - The services enabled during the attach operation | ||
| * - ``reboot_required`` | ||
| - *bool* | ||
| - True If the system requires a reboot after the attach operation |
There was a problem hiding this comment.
Suggested change
| - True If the system requires a reboot after the attach operation | |
| - True if the system requires a reboot after the attach operation |
docs/references/api.rst
Outdated
| * - ``contract_status`` | ||
| - *str* | ||
| - The current contract status (active, grace-period, active-soon-to-expire, expired). | ||
| Please refer to the explanation tab for a description of each state |
There was a problem hiding this comment.
Suggested change
| Please refer to the explanation tab for a description of each state | |
| Please refer to the explanation tab for a description of each state. |
lucasmoura
force-pushed
the
new-api-docs
branch
from
327a992
to
1aaef91
Compare
|
@s-makin fixed |
s-makin
approved these changes
Apr 11, 2024
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.
Why is this needed?
Add documentation for the following API related changes:
Test Steps
Verify if the documentation page is correctly rendered and we are not missing any information related to the API changes
Checklist
Does this PR require extra reviews?