Dokumentation

Übersicht

Tutorials
Anleitungen
Infrastruktur
Referenz
Erklärung
Auf dieser Seite

Maschinenzugang ist der primäre Zugang: Alles liegt sprachneutral an der Wurzel von openhelvetia.swiss. Kein Konto, kein Schlüssel, keine Cookies.

Schritte

  1. Wurzel-Zeiger lesen. GET /.well-known/openhelvetia.json: Identität des Vereins und ein Objekt pointers mit zehn Zeigern, darunter directory, standard, publish, llms, security.
  2. Index holen. pointers.directory führt zu /directory.json: ein Umschlag mit version, $schema, authority und entries.
  3. Manifest holen, wenn es darauf ankommt. Jede Eintragszeile trägt die absolute URL ihres Manifests. authority = manifest heisst: Bei jeder Abweichung gilt das Manifest, der Index ist abgeleitet.
  4. Lebendigkeit prüfen, bevor Sie aufrufen. interfaces[].probe nennt den minimalen unschädlichen Aufruf (kind) und was als Antwort genügt (expect); optional nennt target eine Probe-URL, die vom Endpunkt abweicht. Die Probe-Arten stehen in der Referenz.

Der Umschlag

{
  "$schema": "https://ld.openhelvetia.swiss/ns/directory/0.2/schema",
  "authority": "manifest",
  "entries": [],
  "version": "0.2"
}

So sieht der Umschlag ohne Einträge aus; er ist auch dann gültig. Heute trägt entries die zwei eigenen Einträge des Vereins. Die Reihenfolge der Schlüssel ist die ausgelieferte.

Was eine Eintragszeile trägt

  • slug — Registerkennung, zugleich Pfad unter /directory/
  • name, description — Sprach-Maps
  • publisher, license — IRIs
  • manifest — absolute URL der byte-identischen Manifest-Kopie
  • interfaces[]type, endpoint, optional tier, docs und probe

Alle Oberflächen an der Wurzel: Maschinen-Oberflächen.