-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
[VIRTS-2887] Update Swagger Docs #2324
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.
|
…mitre/caldera into bleepbop/VIRTS-2887/update-swagger-docs
Kudos, SonarCloud Quality Gate passed!
|
* 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
Description
Updated swagger docs for several APIs. Some objects only require certain schema fields, so the
aiohttp
request schemas have been updated to show this.aiohttp_apispec
issues 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: