Repository navigation
docs(api): mark stub routes deprecated/not-implemented in Swagger - #647
Closed
yggdrasilworld wants to merge 3 commits into
Closed
yggdrasilworld wants to merge 3 commits into
yggdrasilworld wants to merge 3 commits into
Conversation
POST /bounties/:id/approve, /bounties/:id/reject, and /milestones/:id/allocate are stubs (see MergeFi#253) that return static responses, but Swagger presented them as working operations with standard success responses — consumers building against /api/docs had no hint that nothing happens. Mark each @apioperation deprecated + describe the stub status so the contract reflects reality until the routes are implemented. Resolves MergeFi#613
|
Someone is attempting to deploy a commit to the chonilius' projects Team on Vercel. A member of the Team first needs to authorize it. |
The shared base carried half-written merge artifacts: an orphaned invokeOnLockedEscrow block in escrow.service.ts, duplicated returns plus a dead parsePagination in sponsors.controller.ts, and missing describe/it closers in github-webhooks.service.spec.ts. Aligned each with the intended form so the branch typechecks and its specs load.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Marks the three stub routes as
deprecated: true+Not implementedin the Swagger contract —POST /bounties/:id/approve,POST /bounties/:id/reject, andPOST /milestones/:id/allocateare stubs (see #253) that return static responses, but Swagger presented them as working operations with standard success responses.Why
API consumers building against
/api/docshad no hint that nothing happens on these routes — the contract lied about the behavior. Marking themdeprecated+ describing the stub-status makes the contract reflect reality until they're implemented.Changes
bounties.controller.ts—approve+reject:@ApiOperation({ deprecated: true, description: 'Not implemented — stub route (see #253); returns a static response.' })milestones.controller.ts—allocate: same markingPer the suggested fix —
deprecated: true+ the not-implemented description (rather than removing the routes, which preserves discoverability of the intended API surface).Resolves #613
Payment: Base USDC
0xD40Df5c27cEa7dd78A3c345401995c319589334e