Skip to content
Gospl Wiki

Overview

Gospl — Weekly Summary API 0.1.0-draft

Section titled “Gospl — Weekly Summary API 0.1.0-draft”

Contract for the Weekly Summary module. Authored by Claude as the handoff artifact to the external API team. Drives implementation, client types, Prism mock, and the wiki API page. x-gospl-frs tags operations to spec FR/US IDs. Shared schemas (UserRef, Role) are owned by contracts/_platform/identity.yaml. Visibility uses the platform access ladder (PR-06). NOTE: email side-effects (manager-on-submit, employee-on-response, Monday digest, consolidated reminder) are triggered by these endpoints but delivered by the NOTIFICATIONS layer (_platform/notifications.md, planned) — they are not endpoints here. Week boundaries use the shared week definition (G1). OPEN: G1 week definition · Q3 trend-significance threshold · Q2 response visibility · Q4 comms audit before reminder consolidation.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/summaries
POST
/summaries
GET
/summaries/default-week
GET
/summaries/{summaryId}
PATCH
/summaries/{summaryId}
POST
/summaries/{summaryId}/response
GET
/summaries/reports/weekly-digest
GET
/summaries/insights/trends

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

Carries tenant + viewer + roles. Tenant-scoped; visibility per PR-06.

Security scheme type: http

Bearer format: JWT