feat: complete API collections with all documented endpoints#218
Merged
ogazboiz merged 1 commit intoLabsCrypt:mainfrom Mar 26, 2026
Merged
Conversation
The existing collections only covered Health, Create Stream, and SSE endpoints, and used paths without the required /v1/ prefix. This update adds all missing endpoints and fixes path prefixes. Added endpoints: - Streams: List streams, Get stream by ID, Get stream events, Get claimable amount - Users: Register wallet, Get user by public key, Get current user (authenticated), Get user activity events - Health: Swagger UI, OpenAPI JSON spec Fixes: - All versioned paths now use /v1/ prefix (e.g. /v1/streams) - Environment files include streamId and authToken variables - Sandbox mode documented in collection description Closes LabsCrypt#141
ogazboiz
approved these changes
Mar 26, 2026
Contributor
ogazboiz
left a comment
ogazboiz
left a comment
There was a problem hiding this comment.
this is clean, well-structured work — thanks for completing the API collections, @Itodo-S! 🎉
you've covered every documented endpoint, updated them all to the /v1/ prefix, added the missing Users collection, Swagger UI entries, and the sandbox mode note in the Postman description. that's exactly what this needed.
CI is all green and there are no conflicts. merging this in!
come hang with us on Telegram if you haven't already: https://t.me/+DOylgFv1jyJlNzM0
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.
Summary
The existing Postman and Hoppscotch collections only covered 5 endpoints (health, create stream, SSE subscribe, SSE stats) and used paths without the required
/v1/prefix. This PR completes both collections with all 15 documented API endpoints and fixes the path prefixes.Added endpoints
/api-docs/api-docs.json/v1/streams(list)/v1/streams/{streamId}/v1/streams/{streamId}/events/v1/streams/{streamId}/claimable/v1/users(register)/v1/users/{publicKey}/v1/users/me(auth)/v1/users/{publicKey}/eventsFixes
/v1/prefix (was missing before)local+test, both Postman and Hoppscotch) now includestreamIdandauthTokenvariablesFiles changed (6)
docs/api/flowfi.postman_collection.json— complete rewrite with all 15 endpointsdocs/api/flowfi.hoppscotch_collection.json— complete rewrite with all 15 endpointsdocs/api/local.postman_environment.json— addstreamId,authTokendocs/api/test.postman_environment.json— addstreamId,authTokendocs/api/local.hoppscotch_environment.json— addstreamId,authTokendocs/api/test.hoppscotch_environment.json— addstreamId,authTokenTest plan
flowfi.postman_collection.jsoninto Postman — verify all 15 requests appearlocal.postman_environment.json— verify variables resolve in requestsflowfi.hoppscotch_collection.jsoninto Hoppscotch — verify all 15 requests appearlocal.hoppscotch_environment.json— verify variables resolveGET /healthto a running backend — verify 200 responseCloses #141