Rewrite of snip_managing-packages-api.adoc #3444
Open
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
rh-max
added
the
Needs style review
|
The PR preview for 7c11135 is available at theforeman-foreman-documentation-preview-pr-3444.surge.sh The following output files are affected by this PR: |
There was a problem hiding this comment.
Converting the steps to a description of the request data is nice!
I suggest to have something as follows:
.API procedure
. Create your API request body:
+
...
...
. Send your API request to {Project}:
+
...
...
Having a sentence about the API above the "API procedure" title looks off to me.
|
|
||
| .Verification | ||
| * In the {ProjectWebUI}, navigate to *Monitor* > *Jobs* and see the report of the scheduled or completed remote execution job to {PackageAction} the packages on the selected hosts. | ||
|
|
Lennonka
requested changes
Nov 14, 2024
| @@ -1,67 +1,69 @@ | |||
| Create a body of the API request in the JSON format by following the instructions below. | |||
| Supply your API request in the JSON format. | |||
There was a problem hiding this comment.
Suggested change
| Supply your API request in the JSON format. |
|
|
||
| * Specify your API request: |
There was a problem hiding this comment.
Suggested change
| * Specify your API request: | |
| . Supply the API request body in the JSON format: |
The API procedure contains two steps. Therefore, numbered list should be used. Also, this step defines the body. The actual API request is in the second step.
| * If you omit this field, it defaults to `"static_query"`. | ||
| -- | ||
|
|
||
| * Send a `POST` request with the created body to the `/api/job_invocations` endpoint of your {ProjectServer} and see a formatted response: |
There was a problem hiding this comment.
Suggested change
| * Send a `POST` request with the created body to the `/api/job_invocations` endpoint of your {ProjectServer} and see a formatted response: | |
| . Send a `POST` request with the created body to the `/api/job_invocations` endpoint of your {ProjectServer} and see a formatted response: |
pr-processor
bot
added
the
Waiting on contributor
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 changes are you introducing?
Rewrite of the snip_managing-packages-api.adoc snippet.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
https://issues.redhat.com/browse/SAT-28719
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into: