Strukturelemente

Diese Seite zeigt die Darstellungsformen der Workspace-Dokumentation. Sie dient als visuelle Referenz für Typografie, Farben, Tabellen, Code und Hinweisboxen.

Inline-Elemente

Inline-Code markiert kurze technische Werte wie config.json, /docs/de/ oder DOCS_SERVER_VERSION direkt im Textfluss.

Tastaturkürzel werden als KBD gerendert: Ctrl K öffnet die Suche, Esc schließt ein Overlay.

Badges kennzeichnen kurze Statusangaben: Standard Optional Aktiv Prüfen Fehler

API-Endpunkte werden kompakt mit Methode und Pfad dargestellt: GET/api/v1/ping GET/api/v1/meta/discovery

Listen

  • Produktbegriffe erscheinen einheitlich im jeweiligen Kontext.
  • Beispiele verwenden neutrale Platzhalter.
  • Links führen zu weiterführenden öffentlichen Inhalten.

Tabellen

ElementEinsatzDarstellung
Inline-CodeDateinamen, Pfade, Befehlesite.css
KBDTastaturaktionenEnter
BadgeStatus oder kurze EinordnungBereit
API-EndpunktMethode und PfadGET/api/v1/ping

Info-Box

Tipp-Box

Warnungs-Box

Gefahren-Box

Code-Blöcke

Mehrzeilige Code-Blöcke zeigen Befehle, Konfigurationen oder API-Beispiele.

bash
curl --fail --silent --show-error https://workspace.example/api/v1/ping
json
{
  "name": "Workspace Docs",
  "basePath": "/docs/",
  "public": true
}

Code-Tabs

Mehrere gleichwertige Beispiele erscheinen in auswählbaren Code-Tabs. Das erste Beispiel ist initial aktiv.

curl
curl --fail --silent --show-error \
  -H "Accept: application/json" \
  https://workspace.example/api/v1/meta/discovery
bash
curl --fail --silent --show-error \
  https://workspace.example/api/v1/meta/discovery \
  | jq '.data | {apiMajor, serverVersion, builtAt, capabilities}'
go
resp, err := http.Get("https://workspace.example/api/v1/meta/discovery")
if err != nil {
  return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
  return fmt.Errorf("discovery returned %s", resp.Status)
}
php
$response = file_get_contents('https://workspace.example/api/v1/meta/discovery');
if ($response === false) {
    throw new RuntimeException('Discovery konnte nicht gelesen werden.');
}
echo $response;

Diagramme

Diagramme veranschaulichen kompakte Abläufe und technische Zusammenhänge.

docs_reference client Client workspace Workspace API client->workspace Anfrage response Antwort workspace->response Ergebnis response->client

Screenshots

Screenshots können eine helle und eine dunkle Ansicht anbieten. Der Schalter an der Bildbeschriftung wechselt zwischen beiden Varianten. Ein Klick auf den Screenshot öffnet die Abbildung in einer großen Ansicht.

Workspace-Anmeldebildschirm
Workspace-Anmeldebildschirm

API-Dokumentationsblock

Ein API-Dokumentationsblock fasst einen veröffentlichten Endpunkt mit Parametern, Rückgabe und Beispielen zusammen.

Serverfähigkeiten lesen

GET/api/v1/meta/discovery

Liefert den API-Major, diagnostische Build-Metadaten und die global sichtbaren Runtime-Fähigkeiten. Der öffentliche Endpunkt benötigt keine Authentisierung und verändert keine Daten.

BereichNameTypPflichtBeschreibung
Responsedata.apiMajorstringJaBediente HTTP-API-Major-Lane, zum Beispiel v1.
Responsedata.serverVersionstringJaDiagnostische Build- oder Release-Kennung.
Responsedata.builtAtstringJaBest-Effort-Build-Metadatum; Entwicklungsbuilds können unknown liefern.
Responsedata.capabilitiesstring[]JaAutoritative globale Fähigkeitssignale für optionale Runtime-Funktionen.
StatusRückgabeBedeutung
200Envelope<PublicDiscoveryResponse>Die öffentliche Runtime-Discovery wurde gelesen.
curl
curl --fail --silent --show-error \
  -H "Accept: application/json" \
  https://workspace.example/api/v1/meta/discovery
go
resp, err := http.Get("https://workspace.example/api/v1/meta/discovery")
if err != nil {
  return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
  return fmt.Errorf("discovery returned %s", resp.Status)
}
var payload struct {
  Data struct {
    APIMajor      string   `json:"apiMajor"`
    ServerVersion string   `json:"serverVersion"`
    BuiltAt       string   `json:"builtAt"`
    Capabilities  []string `json:"capabilities"`
  } `json:"data"`
}
if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
  return err
}
fmt.Println(payload.Data.APIMajor)
php
$response = file_get_contents('https://workspace.example/api/v1/meta/discovery');
if ($response === false) {
    throw new RuntimeException('Discovery konnte nicht gelesen werden.');
}
$payload = json_decode($response, true, flags: JSON_THROW_ON_ERROR);
echo $payload['data']['apiMajor'], PHP_EOL;

Überschrift Dritter Ebene

Unterabschnitt

Die Inhaltsnavigation führt direkt zu den einzelnen Abschnitten dieser Seite.