Configuration · Documentation Specistry

Les objets sont stricts : une clé inconnue fait échouer la validation. Les chemins sont relatifs au projet et doivent y rester, liens symboliques compris.

Champ	Par défaut	Rôle
`schemaVersion`	obligatoire	Actuellement `1`
`name`	obligatoire	1 à 120 caractères
`openapi`	[]	Un chemin ou une liste — un service chacun
`docs`	./docs	Dossier du contenu rédigé
`branding`	—	`accent`, `logo`, `favicon`
`navigation`	pages, puis API	Sections, pages, position de l’API, liens
`environments`	`{}`	URL de base nommées pour les exemples
`sdks`	[]	Exemples SDK explicites
`playground`	désactivé	Exécution directe depuis le navigateur
`quality`	failOn: error	Niveaux, seuils, exceptions

specistry.config.ts

import { defineConfig } from "@specistry/config";

export default defineConfig({
  schemaVersion: 1,
  name: "TestInbox",
  openapi: "./openapi.yaml",
  docs: "./docs",
  branding: { accent: "#297bf3", logo: "./assets/logo.svg" },
  navigation: [
    "quickstart",
    { section: "Guides", items: ["guides/webhooks"] },
    { api: true, label: "Référence API" },
  ],
  environments: {
    sandbox: { baseUrl: "https://sandbox.testinbox.email" },
  },
  playground: { mode: "browser", environments: ["sandbox"] },
  quality: { failOn: "warning", maxWarnings: 0 },
});