Swagger Documentation Sync - Mandatory Rule
MANDATORY: Any change to an API endpoint schema must be reflected in the Swagger documentation. Do not consider an API change complete until Swagger is updated.
When This Rule Applies
Automatically applies whenever you are:
- Modifying files in
front-api/routes/** - Adding, removing, or renaming fields in request/response bodies (at any nesting level)
- Changing field types or optionality in API schemas
- Adding or removing endpoints
What to Update
When modifying API schemas, check and update the following:
front-api/routes/swagger_private_schemas.ts— shared schemas for the private APIfront-api/routes/v1/w/[wId]/swagger_schemas.ts— shared schemas for the public API- The
@swaggerannotation in the endpoint file itself
Annotations
- Every endpoint must have either a
@swaggerannotation (with proper documentation) or@ignoreswagger(for internal/undocumented endpoints). This is enforced by thelint:swagger-annotationscheck. - TypeScript types annotated with
@swaggerschemapoint to a corresponding swagger schema. When modifying such a type, always update the referenced schema.
Example:
typescript/** * @swaggerschema PrivateUser (swagger_private_schemas.ts) */ export type UserTypeWithWorkspaces = UserType & { workspaces: WorkspaceType[]; };
Process
- Make the API/type change
- Identify which swagger files reference the modified schema
- Update all relevant
@swaggerannotations and shared schema files - Verify
lint:swagger-annotationspasses
You don't need to manually invoke this skill - these guidelines should be followed automatically for any API-related work.
