feat(FM-IC-CFG-002): public API for workflow automation + OpenAPI spec - #199
Open
SpikeyCoder wants to merge 7 commits into
Open
feat(FM-IC-CFG-002): public API for workflow automation + OpenAPI spec#199SpikeyCoder wants to merge 7 commits into
SpikeyCoder wants to merge 7 commits into
Conversation
Adds a documented, read-only public API over a user's grant pipeline so
teams can automate workflows (Zapier/Make/scripts/BI) — closing the
Instrumentl gap flagged PARTIAL in the 2026-06-14 usability audit
('No public OpenAPI yet').
Backend:
- Migration 20260614140000_cfg002_api_keys.sql: api_keys table (user-scoped
RLS; SHA-256 key hash + display prefix; soft-revoke; read scope).
- Edge function public-api: API-key-authenticated read endpoints
(/v1/projects, /v1/pipeline-statuses, /v1/tracked-grants, /v1/saved-funders)
plus a public GET /openapi.json (OpenAPI 3.0) and service descriptor.
- Edge function api-keys: JWT-authenticated key manager (create/list/revoke);
raw secret returned exactly once.
Frontend:
- ApiKeysSettings component + new 'API' tab in Account Settings to create,
view, copy (once), and revoke keys; links to the OpenAPI spec.
Docs:
- PUBLIC_API.md: base URL, auth, endpoint table, curl example.
npm run build passes (tsc -b && vite build).
Deploying funder-finder with
|
| Latest commit: |
442a242
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://820024d2.funder-finder.pages.dev |
| Branch Preview URL: | https://feature-fm-ic-cfg-002-public.funder-finder.pages.dev |
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
1 participant
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.
FM-IC-CFG-002 — Public API for workflow automation
Addresses Instrumentl competitive gap CFG-002.
Backend
api_keystable with SHA-256 hashed keys, soft-revoke, RLSpublic-apiedge function: OpenAPI 3.0 spec + key-authenticated read-only endpoints (/v1/projects,/v1/pipeline-statuses,/v1/tracked-grants,/v1/saved-funders)api-keysmanagement edge functionPUBLIC_API.mddocumentationFrontend
/docs/apipage — interactive Swagger UI docs page (public, no auth required) that loads the OpenAPI specframe-src blob:for Swagger UI renderingEdge functions to deploy after merge
public-api(new)api-keys(new)