Documentation des clients
9 routes. Chemins relatifs à https://api.nexus-engine.eu/api/v1.
GET
/clients/:id/documentation
Les pages écrites pour ce client, brouillons compris.
RéponsePortalDocDto[]
POST
/clients/:id/documentation
Crée une page. Le slug vient du titre quand on ne le donne pas ; un slug déjà pris répond 409.
CorpssiteId, slug, title, summary, content (markdown), orderIndex, published, author
RéponsePortalDocDetailDto
PUT
/clients/:id/documentation/:slug
Écrit une page par son slug, qu’elle existe ou non — la forme qu’un agent emploie. Le passage en publié prévient le client.
CorpssiteId, title, summary, content (markdown), orderIndex, published, author
RéponsePortalDocDetailDto
GET
/documentation/:docId
Une page, son contenu et ses captures.
RéponsePortalDocDetailDto
PATCH
/documentation/:docId
Modifie une page. Seuls les champs nommés changent.
CorpssiteId, slug, title, summary, content, orderIndex, published, author
RéponsePortalDocDetailDto
DELETE
/documentation/:docId
Supprime une page et ses captures.
Réponse{ ok }
POST
/documentation/:docId/images
Ajoute une capture (PNG, JPEG, WebP, GIF ; 2 Mo) et rend l’adresse à écrire dans le markdown.
Corpsname, mimeType, dataBase64
RéponsePortalDocImageDto
GET
/documentation/:docId/images/:imageId
Une capture d’une page, pour l’écran de l’agence.
Réponseimage
DELETE
/documentation/:docId/images/:imageId
Retire une capture.
Réponse{ ok }