Skip to content

Add API documentation for /contacts/{name}#2424

Merged
bleepbop merged 3 commits into
masterfrom
api/v2/contacts
Jan 6, 2022
Merged

Add API documentation for /contacts/{name}#2424
bleepbop merged 3 commits into
masterfrom
api/v2/contacts

Conversation

@damionmounts
Copy link
Copy Markdown
Contributor

Description

Added API documentation for:

  • HEAD /api/v2/contacts/{name}
  • GET /api/v2/contacts/{name}

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

How Has This Been Tested?

I built and observed the changes to the API documentation page.

Checklist:

  • My code follows the style guidelines of this project
    • I believe it does
      • I matched the style of other multiline doc decorators
      • I kept under the flake8 line length of 180 (I folded at 119 chars, not sure if changing that would be more preferable)
  • 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

@damionmounts damionmounts requested a review from bleepbop January 3, 2022 04:05
Copy link
Copy Markdown

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

@damionmounts damionmounts requested a review from clenk January 3, 2022 04:06
Comment thread app/api/v2/handlers/contact_api.py Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 6, 2022

Codecov Report

Merging #2424 (c15df99) into master (c1ce024) will not change coverage.
The diff coverage is 100.00%.

❗ Current head c15df99 differs from pull request most recent head a0021bc. Consider uploading reports for the commit a0021bc to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2424   +/-   ##
=======================================
  Coverage   73.04%   73.04%           
=======================================
  Files         112      112           
  Lines        8070     8070           
=======================================
  Hits         5895     5895           
  Misses       2175     2175           
Impacted Files Coverage Δ
app/api/v2/handlers/contact_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 307251e...a0021bc. Read the comment docs.

@bleepbop bleepbop self-requested a review January 6, 2022 18:58
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jan 6, 2022

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

100.0% 100.0% Coverage
0.0% 0.0% Duplication

1 similar comment
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jan 6, 2022

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

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@bleepbop bleepbop merged commit 2ac98e5 into master Jan 6, 2022
@bleepbop bleepbop deleted the api/v2/contacts branch January 6, 2022 19:13
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.

3 participants