Skip to content

feat: implement central API reference foundation #1

Closed
7 of 7 issues completed
Closed

Description

@lusu007

Ziel

Den freigegebenen Plan API01.1 – api-reference: Central Scalar App Foundation vollständig umsetzen.

Das Repository liefert eine öffentliche, statische Multi-Spec-Referenz für https://api.grounds.gg/docs. Die App konsumiert ausschließlich versionierte OpenAPI-Snapshots aus dem eigenen Repository und veröffentlicht ein unprivilegiertes OCI-Image.

Reihenfolge

  1. App- und Tooling-Basis
  2. Registry-Vertrag
  3. Scalar-Multi-Source-Rendering
  4. Buildzeit-Spec-Validierung
  5. Container-Image
  6. CI und Release
  7. Betriebs- und Integrationsdokumentation

Die Arbeitspakete werden als native GitHub Sub-Issues verknüpft.

Gesamtakzeptanz

  • Node-24-App baut reproduzierbar unter dem Base Path /docs/
  • Leere und nichtleere Quellenregistries werden korrekt behandelt
  • Specs werden ausschließlich same-origin aus /docs/specs/ geladen
  • Registry, Pfade und OpenAPI-Dokumente werden vor dem Build validiert
  • Scalar besitzt keinen Proxy, keine Auth-Defaults und keinen API-Client-Button
  • Das unprivilegierte OCI-Image läuft auf Port 8080 und erfüllt die Routing-Smokes
  • Releases veröffentlichen versionierte Images nach GHCR
  • Keine laufenden Services oder Runtime-Secrets sind für Build oder Betrieb erforderlich

Nicht enthalten

  • Kubernetes-Deployment oder Ingress
  • Mintlify-Navigation
  • Service-spezifische OpenAPI-Generierung
  • Cross-Repo-Automation für Snapshot-PRs

Diese Punkte erhalten getrennte repository-spezifische Pläne.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions