Skip to content

DM-54400: Update project API details#3

Merged
jonathansick merged 5 commits intomainfrom
tickets/DM-54400
Mar 18, 2026
Merged

DM-54400: Update project API details#3
jonathansick merged 5 commits intomainfrom
tickets/DM-54400

Conversation

@jonathansick
Copy link
Copy Markdown
Member

Summary

Updates the SQR-112 design document to reflect recent Docverse API implementation work:

  • Document keyset pagination query parameters (cursor, limit, order) and response headers (Link, X-Total-Count) for all collection endpoints
  • Add fuzzy search (q parameter) for project listing using PostgreSQL pg_trgm trigram similarity, with GIN indexes on slug and title
  • Add query parameter tables for builds (with status filter) and editions (with kind filter)
  • Change build status enum: rename uploadingpending, add uploaded as a signal-only value
  • Switch org_memberships and organization_credentials PKs from UUID to int auto-increment

Cross-reference: lsst-sqre/docverse#138

Test plan

  • Verify the technote builds and renders correctly on sqr-112.lsst.io

Aligns the design doc with the Docverse implementation, which uses
an integer auto-increment primary key for the org_memberships table.
…ntials

Replace UUID primary keys with integer auto-increment keys to match
the convention used by the rest of the schema. Also fixes the
organization_id FK type in the SQL example.
Expand the API conventions section with pagination details (cursor,
limit, order, Link header, X-Total-Count). Add query parameter tables
for projects, editions, and builds collection endpoints.
Add the q query parameter to GET /orgs/:org/projects that enables
trigram-based fuzzy search across project slug and title using pg_trgm.
Document the GIN trigram indexes on the projects table.
@jonathansick jonathansick merged commit 0e11ad4 into main Mar 18, 2026
2 checks passed
@jonathansick jonathansick deleted the tickets/DM-54400 branch March 18, 2026 14:54
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.

1 participant