Skip to main content

Le flux

Personne ne maintient une spec à la main : elle est générée depuis le code. Chaque audience a ses propres routes, donc sa propre spec. rs publie en plus une spec AsyncAPI pour ses WebSockets.

Les packages clients

Un front importe le client de son audience : les appels sont typés, et un changement d’API casse la compilation du front immédiatement plutôt qu’à l’exécution.
apps/provider est entièrement sur @kare/pr-api. apps/kare migre module par module de @kare/sdk vers @kare/rs-api et dépend encore des deux. backoffice et audit sont sur @kare/sdk.

Publication de cette doc

publish-docs.yml part sur un push de main touchant openapi/** :
1

Changelog

Le numéro de PR est extrait du sujet du commit de squash ((#123)), puis yarn docs:changelog écrit le bloc dans changelog/ de ce repo. Sans SHA de base ni numéro de PR (run manuel, push hors PR), l’étape est sautée.
2

Specs

openapi/ remplace intégralement api/ dans ce repo.
3

Commit

Un token de GitHub App pousse chore: sync API specs + changelog from monorepo@<sha>.
Le workflow ne touche que api/ et changelog/. Il ne met pas à jour docs.json : une nouvelle page de changelog doit être ajoutée à la navigation à la main.