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

Add Swagger documentation for locking #1304

Merged
merged 1 commit into from
Mar 15, 2024
Merged

Add Swagger documentation for locking #1304

merged 1 commit into from
Mar 15, 2024

Conversation

iamacook
Copy link
Member

Summary

This adds the Swagger documentation for the locking-relevant endpoints.

/v1/locking/leaderboard/{safeAddress}

image

/v1/locking/leaderboard

image

/v1/locking/history

image

Changes

  • Add/use types for lock, unlock and withdraw events of the locking history
  • Create class-based schemas implementing said types
  • Use class-based schemas in controller
  • Add query parameter overview to controller

@iamacook iamacook self-assigned this Mar 15, 2024
Comment on lines +2 to +6
import {
LockEventItem,
UnlockEventItem,
WithdrawEventItem,
} from '@/domain/locking/entities/locking-event.entity';
Copy link
Member Author

Choose a reason for hiding this comment

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

The changes in this file are only type related.

@iamacook iamacook marked this pull request as ready for review March 15, 2024 10:41
@iamacook iamacook requested a review from a team as a code owner March 15, 2024 10:41
@coveralls
Copy link

Pull Request Test Coverage Report for Build 8294903735

Details

  • 43 of 43 (100.0%) changed or added relevant lines in 5 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.02%) to 93.651%

Files with Coverage Reduction New Missed Lines %
src/routes/transactions/entities/tests/human-description.builder.ts 1 90.0%
Totals Coverage Status
Change from base Build 8284969768: 0.02%
Covered Lines: 6509
Relevant Lines: 6718

💛 - Coveralls

@iamacook iamacook merged commit 5b0f867 into main Mar 15, 2024
16 checks passed
@iamacook iamacook deleted the locking-swagger branch March 15, 2024 15: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.

None yet

3 participants