VIRTS-3151 Agents HEAD/GET/POST documentation#2398
Merged
wbooth merged 7 commits intoDec 22, 2021
Merged
Conversation
yee-jonathan
added
the
documentation
bleepbop
reviewed
Dec 15, 2021
bleepbop
suggested changes
Dec 15, 2021
Contributor
bleepbop
left a comment
bleepbop
left a comment
There was a problem hiding this comment.
Just one tiny change, everything else looks good to me
yee-jonathan
commented
Dec 16, 2021
Contributor
Author
yee-jonathan
left a comment
yee-jonathan
left a comment
There was a problem hiding this comment.
Fixed line 35 to be in Flake8 compliance
bleepbop
reviewed
Dec 16, 2021
bleepbop
suggested changes
Dec 16, 2021
Contributor
bleepbop
left a comment
bleepbop
left a comment
There was a problem hiding this comment.
One last change in the GET /agents description and it should be good to go!
|
Kudos, SonarCloud Quality Gate passed!
|
Contributor
Author
|
Changed wording in lines 31 and 34 to more accurately reflect how a GET for /agents is handled |
bleepbop
approved these changes
Dec 16, 2021
wbooth
approved these changes
Dec 20, 2021
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
Adding API documentation for
/agentsendpoint.Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Added summary and description documentation to
/agentsendpoint. After navigating toapi docs, confirmed that summary and description appear under the appropriate agent field with the correct formatting.Checklist: