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.

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

chore: add Api operation decorator for summary description #37

Merged
merged 3 commits into from
Oct 5, 2023

Conversation

dutterbutter
Copy link
Contributor

What ❔

  • Adds @ApiOperation decorator to include summary description of API method

Why ❔

  • Provides a description of the API call for automated documentation
Screenshot 2023-10-05 at 8 20 51 AM

Checklist

  • PR title corresponds to the body of PR (we generate changelog entries from PRs).
  • Tests for the changes have been added / updated.
  • Documentation comments have been added / updated.
  • Code has been formatted via zk fmt and zk lint.

@github-actions
Copy link

github-actions bot commented Oct 5, 2023

API E2E Test Results

179 tests   179 ✔️  31s ⏱️
  11 suites      0 💤
    1 files        0

Results for commit a2abe50.

♻️ This comment has been updated with latest results.

@github-actions
Copy link

github-actions bot commented Oct 5, 2023

Visit the preview URL for this PR (updated for commit a2abe50):

(expires Thu, 12 Oct 2023 16:12:17 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: e508f9012944951194447cb8885950b451a24403

@github-actions
Copy link

github-actions bot commented Oct 5, 2023

Unit Test Results

       3 files     235 suites   2m 42s ⏱️
1 784 tests 1 783 ✔️ 1 💤 0
1 809 runs  1 808 ✔️ 1 💤 0

Results for commit a2abe50.

♻️ This comment has been updated with latest results.

vasyl-ivanchuk
vasyl-ivanchuk previously approved these changes Oct 5, 2023
Romsters
Romsters previously approved these changes Oct 5, 2023
@dutterbutter dutterbutter dismissed stale reviews from Romsters and vasyl-ivanchuk via f76371c October 5, 2023 15:28
@vasyl-ivanchuk vasyl-ivanchuk merged commit da98913 into main Oct 5, 2023
@vasyl-ivanchuk vasyl-ivanchuk deleted the db/add-description-docs branch October 5, 2023 16:13
@github-actions
Copy link

github-actions bot commented Oct 9, 2023

🎉 This PR is included in version 2.10.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants