[VIRTS-2887] Update Swagger Docs#2324
Merged
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2324 +/- ##
==========================================
- Coverage 72.62% 72.60% -0.02%
==========================================
Files 110 110
Lines 7942 7944 +2
==========================================
Hits 5768 5768
- Misses 2174 2176 +2
Continue to review full report at Codecov.
|
uruwhy
reviewed
Oct 22, 2021
uruwhy
reviewed
Oct 22, 2021
3 tasks
…mitre/caldera into bleepbop/VIRTS-2887/update-swagger-docs
uruwhy
approved these changes
Oct 22, 2021
wbooth
approved these changes
Oct 27, 2021
|
Kudos, SonarCloud Quality Gate passed!
|
cyber-arsenull
pushed a commit
that referenced
this pull request
Dec 28, 2021
* update required schemas for all endpoints but operations * adjust operation update schemas * Update operation request schemas * silence marshmallow warnings * add summary to objects with nested sources * silence unnecessary aiohttp apispec warnings in test server
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
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
Updated swagger docs for several APIs. Some objects only require certain schema fields, so the
aiohttprequest schemas have been updated to show this.aiohttp_apispecissues a warning when the exclude/include parameters are added to the request schema, however this has no side effect on the actual API functionality, so those warnings have been silenced inserver.py. Lastly, some schemas do not allow for excluding/including certain fields (the adjustments field in the Source schema, to be specific), so APIs relying on said schemas will have summaries indicating fields that can be excluded/included.Type of change
How Has This Been Tested?
Verified request schemas work with Pytest.
Checklist: