Add plugin apidocs details #2371

argaudreau · 2021-11-23T18:56:12Z

Description

Adds more information to the swagger documentation for plugin endpoints.

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Swagger documentation is updated with new information.

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

codecov · 2021-11-23T19:02:19Z

Codecov Report

Merging #2371 (6ad36ce) into master (b478416) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #2371   +/-   ##
=======================================
  Coverage   72.74%   72.74%           
=======================================
  Files         110      110           
  Lines        7948     7948           
=======================================
  Hits         5782     5782           
  Misses       2166     2166

Impacted Files	Coverage Δ
app/api/v2/handlers/plugins_api.py	`100.00% <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 b478416...6ad36ce. Read the comment docs.

bleepbop

Looks good! This is a bit redundant, but just for consistency with the other endpoints, can you add an aiohttp_apispec.response description for these? It could just be something like "Returns a list of all Plugin objects dumped in PluginSchema format."

iguannalin

lgtm!

argaudreau · 2021-11-29T17:37:30Z

Looks good! This is a bit redundant, but just for consistency with the other endpoints, can you add an aiohttp_apispec.response description for these? It could just be something like "Returns a list of all Plugin objects dumped in PluginSchema format."

Makes sense, added a description field there!