Skip to content

Add plugin apidocs details#2371

Merged
wbooth merged 3 commits into
masterfrom
apidocs-plugins
Dec 1, 2021
Merged

Add plugin apidocs details#2371
wbooth merged 3 commits into
masterfrom
apidocs-plugins

Conversation

@argaudreau
Copy link
Copy Markdown
Contributor

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
Copy link
Copy Markdown

codecov Bot commented Nov 23, 2021

Codecov Report

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

Impacted file tree graph

@@           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.

Copy link
Copy Markdown
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.

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
iguannalin previously approved these changes Nov 27, 2021
Copy link
Copy Markdown
Contributor

@iguannalin iguannalin left a comment

Choose a reason for hiding this comment

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

lgtm!

@argaudreau
Copy link
Copy Markdown
Contributor Author

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!

@sonarqubecloud
Copy link
Copy Markdown

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

@wbooth wbooth merged commit 5589675 into master Dec 1, 2021
@wbooth wbooth deleted the apidocs-plugins branch December 1, 2021 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants