Reference API

La reference OpenAPI publique est generee a partir du contrat openapi/cyclecore-public-api.json. Elle ne contient que les endpoints publics stables.

Endpoints disponibles

Source technique

La source actuelle est un fichier OpenAPI local, versionne avec la documentation. Le backend expose aussi un schema Swagger/OpenAPI sur /api/docs-json lorsque la documentation technique est active.

Le flux cible est:

1. Stabiliser les endpoints publics dans le backend.
2. Exporter ou synchroniser le schema public depuis /api/docs-json.
3. Garder uniquement les tags publics.
4. Regenerer les pages Fumadocs avec npm run openapi:generate.

A stabiliser avant publication

• GET /public/v1/products/{id}.
• POST /public/v1/products.
• GET /public/v1/channels.
• Endpoints d'exports publics dedies.
• Webhooks publics.

Integration Fumadocs OpenAPI

Le repo docs utilise Fumadocs 16.8.12. La version recente de fumadocs-openapi demande fumadocs-core et fumadocs-ui en 16.9.0 ou plus. L'integration devra donc etre faite dans une prochaine iteration avec:

1. Mise a jour controlee de Fumadocs.
2. Export du schema backend depuis /api/docs-json.
3. Filtrage strict des tags publics.
4. Generation ou import de la reference dans content/docs/api/reference.

Routes a exclure

Ne jamais publier dans cette reference:

• Gestion interne des organisations, membres, roles et permissions.
• Creation, listing et revocation des cles API cote application.
• Stripe, facturation et webhooks internes.
• Onboarding, admin, dashboard et notifications.
• Supabase exchange.
• Connecteurs internes, OAuth, synchronisation, mapping et jobs techniques.
• Routes d'import/export internes non stabilisees comme contrat public.