Skip to content

Virts 3239 #2415

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.

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

Merged
merged 4 commits into from
Dec 21, 2021
Merged

Virts 3239 #2415

merged 4 commits into from
Dec 21, 2021

Conversation

BCHarrell
Copy link

Description

Added documentation for Facts (PATCH) and standardized other facts documentation across a few factors (phrasing, capitalization, singular vs. plural if the endpoint would affect multiple objects).

Type of change

Please delete options that are not relevant.

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

How Has This Been Tested?

Swagger Docs functional.

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 (N/A)

Brent Harrell added 3 commits December 21, 2021 11:06
Added new documentation for PATCH (update) on facts. Made adjustments to
existing documentation to ensure operations that affect multiple facts
or relationships use plural language, not singular, then standardized
wording and capitalization for consistency.
@codecov
Copy link

codecov bot commented Dec 21, 2021

Codecov Report

Merging #2415 (49d16b9) into master (01c9241) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2415   +/-   ##
=======================================
  Coverage   73.22%   73.22%           
=======================================
  Files         112      112           
  Lines        8068     8068           
=======================================
  Hits         5908     5908           
  Misses       2160     2160           
Impacted Files Coverage Δ
app/api/v2/handlers/fact_api.py 81.96% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 01c9241...49d16b9. Read the comment docs.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Wohoo! Your first PR -- thanks for contributing!

@bleepbop bleepbop merged commit 55f3a0e into master Dec 21, 2021
@bleepbop bleepbop deleted the VIRTS-3239 branch December 21, 2021 18:23
heatonk pushed a commit to heatonk/caldera that referenced this pull request Dec 28, 2021
* API Docs - fact PATCH and wording tweaks

Added new documentation for PATCH (update) on facts. Made adjustments to
existing documentation to ensure operations that affect multiple facts
or relationships use plural language, not singular, then standardized
wording and capitalization for consistency.

* Small typo fixes

* Fixed all line overruns

Co-authored-by: Daniel Matthews <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants