infra: wire security gate into CI and sync API docs - #1063
Merged
ogazboiz merged 1 commit intoJul 29, 2026
Conversation
- Run npm run verify-security as part of the Security Checks workflow so a misconfigured security setup fails CI instead of only being caught manually. - Add explicit GitHub Security Advisories reporting instructions to SECURITY.md. - Add missing stream lifecycle endpoints (summary, pause, resume, withdraw, cancel, top-up) to the Postman collection and document the Swagger spec as the source of truth in docs/api/README.md. Closes LabsCrypt#1059 Closes LabsCrypt#1061 Closes LabsCrypt#1062
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
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
Bundles fixes for four small infra/docs issues:
npm run verify-securitywas only ever run manually. Added it as a step in.github/workflows/security.yml(dependency-checkjob) so a broken security setup fails CI. Verified locally: passes clean (6/6) on current config, and exits non-zero (2 failed) whenSECURITY.mdis deliberately removed..github/dependabot.yml: acargoecosystem entry for/contractsalready exists (merged via fix(ci): point Dependabot npm at the workspace root only #772). No change needed here; noting it in this PR so the issue can be closed as already resolved.docs/api/flowfi.postman_collection.jsonstream endpoints against the@openapiJSDoc inbackend/src/routes/v1/stream.routes.tsand related controllers. The existing entries (create/list/get/events/claimable) already matched. Added the endpoints that were missing entirely (summary,pause,resume,withdraw,cancel,top-up) so the collection covers the full stream lifecycle. Addeddocs/api/README.mddocumenting the Swagger spec (backend/src/config/swagger.ts+ route JSDoc, served at/api-docs.json) as the source of truth.SECURITY.mdmentioned GitHub Security Advisories but buried it behind vague "direct contact" wording. Rewrote the "How to Report" section to lead with the GitHub Security Advisories flow and a direct link.CONTRIBUTING.mdalready cross-linksSECURITY.md(Security section), so no change needed there.Closes #1059
Closes #1061
Closes #1062
(#1060 is already resolved on
mainvia #772 — flagging for maintainers to close.)Test plan
node scripts/verify-security-setup.jspasses on current config (6/6)SECURITY.mdis removed (proves the CI gate works)node -e "JSON.parse(...)"validates the edited Postman collection is well-formed JSON@openapiannotations instream.routes.ts,streams/withdraw.ts,controllers/stream/cancel.ts