api-add-route

Étoiles104

Forks32

Mis à jour19 mai 2026 à 15:21

Use when adding or changing an HTTP route under services/api. Walks the exact steps so the new route follows Helpline's gateway conventions.

Installation

Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.

Exécuter dans Manus

Source

coleam00

coleam00/helpline

Ouvrir le dépôt GitHub Voir les dépôts du créateur

Téléchargement

Exécuter dans Manus

Métiers associésSOC

Basé sur la classification professionnelle SOC

Développeurs de logicielsProfessions informatiques et mathématiques·SOC 15-1252

Explorateur de fichiers

2 fichiers

SKILL.md

readonly

name	api-add-route
description	Use when adding or changing an HTTP route under services/api. Walks the exact steps so the new route follows Helpline's gateway conventions.
paths	services/api/**

Adding an API route

Activates for work in services/api. Follow these steps in order.

Write the handler in the matching module (tickets.py for ticket routes, a new module for a new noun). Signature is (request: dict) -> dict.
Validate inputs first. Missing/!bad input raises ValidationError — never return an error dict by hand.
Do no business logic here. Call a repo (packages/db) or another service. The handler only orchestrates and shapes the response.
Register the route in routes.py inside build_app() — app.route("METHOD /path", handler). A route not registered there does not exist.
Add a test in tests/ that builds the app and dispatches the route.

Full checklist with a worked example: references/route-checklist.md.

Plus depuis ce dépôt

même dépôt

billing-money-rules

coleam00/helpline

Use when creating or editing code under services/billing. Enforces Helpline's money-handling rules — integer cents only, seat limits, and BillingError for every violation.

2026-05-19104

scoped-tests

coleam00/helpline

Use after changing code, before claiming work is done — picks the correctly scoped pytest command instead of running the whole suite. Helps avoid the timeout-and-context-waste of full-suite runs on a one-service change.

2026-05-19104

scoped-tests

coleam00/helpline

Use after changing code, before claiming work is done — run the test command scoped to what you changed instead of the whole suite, to avoid the timeout and context waste of full-suite runs on a small change.

2026-05-19104

name	api-add-route
description	Use when adding or changing an HTTP route under services/api. Walks the exact steps so the new route follows Helpline's gateway conventions.
paths	services/api/**

Adding an API route

Activates for work in services/api. Follow these steps in order.

Write the handler in the matching module (tickets.py for ticket routes, a new module for a new noun). Signature is (request: dict) -> dict.
Validate inputs first. Missing/!bad input raises ValidationError — never return an error dict by hand.
Do no business logic here. Call a repo (packages/db) or another service. The handler only orchestrates and shapes the response.
Register the route in routes.py inside build_app() — app.route("METHOD /path", handler). A route not registered there does not exist.
Add a test in tests/ that builds the app and dispatches the route.

Full checklist with a worked example: references/route-checklist.md.