Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: adds documentation #20

Merged
merged 1 commit into from
Aug 23, 2023
Merged

feat: adds documentation #20

merged 1 commit into from
Aug 23, 2023

Conversation

bolovsky
Copy link
Member

@bolovsky bolovsky commented Aug 23, 2023 •
edited
Loading

@bolovsky bolovsky added the documentation Improvements or additions to documentation label Aug 23, 2023
@bolovsky bolovsky self-assigned this Aug 23, 2023
@bolovsky bolovsky force-pushed the rlopes/#16_adds_documentation branch from a1674de to 3f25bca Compare August 23, 2023 13:56
@bolovsky bolovsky temporarily deployed to github-pages August 23, 2023 13:56 — with GitHub Pages Inactive
@codecov
Copy link

codecov bot commented Aug 23, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (1680a29) 38.44% compared to head (4fe3cb2) 38.44%.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master      #20   +/-   ##
=======================================
  Coverage   38.44%   38.44%           
=======================================
  Files          15       15           
  Lines         411      411           
=======================================
  Hits          158      158           
  Misses        241      241           
  Partials       12       12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bolovsky bolovsky force-pushed the rlopes/#16_adds_documentation branch from 3f25bca to add341f Compare August 23, 2023 15:08
@bolovsky bolovsky changed the title feat: adds documentation for patch feat: adds documentation Aug 23, 2023
@bolovsky
feat: adds documentation
4fe3cb2 
- Creates Swagger docs (closes #19)
- Adds example for patch /short/:id
- Minor fixes on documentation
- Enables github pages with docs
@bolovsky bolovsky temporarily deployed to github-pages August 23, 2023 15:09 — with GitHub Pages Inactive
@bolovsky bolovsky force-pushed the rlopes/#16_adds_documentation branch from add341f to 4fe3cb2 Compare August 23, 2023 15:11
@bolovsky bolovsky temporarily deployed to github-pages August 23, 2023 15:12 — with GitHub Pages Inactive
fmgAndre
fmgAndre approved these changes Aug 23, 2023
View reviewed changes
Copy link
Contributor

@fmgAndre fmgAndre left a comment •
edited
Loading

Choose a reason for hiding this comment

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

lgtm

@bolovsky bolovsky merged commit afa2393 into master Aug 23, 2023
@bolovsky bolovsky deleted the rlopes/#16_adds_documentation branch August 23, 2023 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fmgAndre fmgAndre fmgAndre approved these changes

Assignees

@bolovsky bolovsky

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create OpenAPI documentation
2 participants
@bolovsky @fmgAndre