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.

Sign up for GitHub

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

Jump to bottom

VIRTS-3151 Agents HEAD/GET/POST documentation #2398

Merged
merged 7 commits into from
Dec 22, 2021
Merged

VIRTS-3151 Agents HEAD/GET/POST documentation #2398

merged 7 commits into from
Dec 22, 2021

Conversation

yee-jonathan
Copy link
Contributor

Description

Adding API documentation for /agents endpoint.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Added summary and description documentation to /agents endpoint. After navigating to api docs, confirmed that summary and description appear under the appropriate agent field with the correct formatting.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

bleepbop
bleepbop requested changes Dec 15, 2021
View reviewed changes
Copy link
Contributor

@bleepbop bleepbop left a comment

Choose a reason for hiding this comment

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

Just one tiny change, everything else looks good to me

yee-jonathan
yee-jonathan commented Dec 16, 2021
View reviewed changes
Copy link
Contributor Author

@yee-jonathan yee-jonathan left a comment

Choose a reason for hiding this comment

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

Fixed line 35 to be in Flake8 compliance

bleepbop
bleepbop requested changes Dec 16, 2021
View reviewed changes
Copy link
Contributor

@bleepbop bleepbop left a comment

Choose a reason for hiding this comment

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

One last change in the GET /agents description and it should be good to go!

@sonarcloud
Copy link

sonarcloud bot commented Dec 16, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@yee-jonathan
Copy link
Contributor Author

Changed wording in lines 31 and 34 to more accurately reflect how a GET for /agents is handled

@yee-jonathan yee-jonathan removed the request for review from ArtificialErmine December 21, 2021 05:44
@wbooth wbooth merged commit f4d6973 into mitre:master Dec 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bleepbop bleepbop bleepbop approved these changes

@wbooth wbooth wbooth approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@yee-jonathan @wbooth @bleepbop @ArtificialErmine