Spedy Docs

Das Wiki bietet eine strukturierte Wissensdatenbank für deine Organisation. Inhalte sind in Spaces organisiert, die Seiten und Ordner enthalten. Spaces können mit Boards für projektspezifische Dokumentation verknüpft werden.

Spaces

Spaces auflisten

GET /api/v1/wiki/spaces

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
boardId	string	Nein	Spaces filtern, die mit einem bestimmten Board verknüpft sind

Beispiel-Response

[
  {
    "id": "ws_abc123",
    "name": "Engineering-Handbuch",
    "slug": "engineering-handbuch",
    "description": "Interne Engineering-Dokumentation",
    "icon": "book",
    "boardId": null,
    "createdAt": "2025-01-15T10:00:00Z"
  }
]

Space erstellen

POST /api/v1/wiki/spaces

Berechtigung erforderlich: wiki:create

Rate-Limit: 10 pro Stunde.

Request Body

Feld	Typ	Pflicht	Beschreibung
name	string	Ja	Space-Name (max. 100 Zeichen)
slug	string	Nein	URL-freundlicher Slug (wird automatisch generiert falls weggelassen)
description	string	Nein	Space-Beschreibung (max. 500 Zeichen)
icon	string	Nein	Icon-Bezeichner
boardId	string	Nein	Board-ID, mit der der Space verknüpft werden soll
memberMode	string	Nein	`INHERIT_BOARD` oder `MANAGE_SEPARATE`

Beispiel-Request

{
  "name": "Engineering-Handbuch",
  "description": "Interne Engineering-Dokumentation"
}

Space abrufen

GET /api/v1/wiki/spaces/{spaceId}

Space-Baum abrufen

GET /api/v1/wiki/spaces/{spaceId}/tree

Gibt die vollständige Ordner- und Seitenhierarchie eines Spaces als Baumstruktur zurück.

Space aktualisieren

PATCH /api/v1/wiki/spaces/{spaceId}

Wiki-Rolle erforderlich: manage

Space löschen

DELETE /api/v1/wiki/spaces/{spaceId}

Wiki-Rolle erforderlich: manage

Gibt 204 No Content zurück.

Verknüpften Space für Board abrufen

GET /api/v1/wiki/spaces/board/{boardId}

Gibt den mit einem bestimmten Board verknüpften Wiki-Space zurück.

Seiten

Seiten auflisten

GET /api/v1/wiki/spaces/{spaceId}/pages

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
folderId	string	Nein	Nach Ordner filtern

Seite erstellen

POST /api/v1/wiki/spaces/{spaceId}/pages

Wiki-Rolle erforderlich: edit oder manage

Rate-Limit: 60 pro Stunde.

Request Body

Feld	Typ	Pflicht	Beschreibung
title	string	Ja	Seitentitel (max. 255 Zeichen)
content	string	Nein	Seiteninhalt (max. 500.000 Zeichen)
folderId	string	Nein	Elternordner-ID
isPublished	boolean	Nein	Ob die Seite veröffentlicht ist

Beispiel-Request

{
  "title": "Erste-Schritte-Anleitung",
  "content": "<h1>Willkommen</h1><p>Diese Anleitung behandelt...</p>",
  "isPublished": true
}

Seite abrufen

GET /api/v1/wiki/spaces/{spaceId}/pages/{pageId}

Seite aktualisieren

PATCH /api/v1/wiki/spaces/{spaceId}/pages/{pageId}

Wiki-Rolle erforderlich: edit oder manage

Seite löschen

DELETE /api/v1/wiki/spaces/{spaceId}/pages/{pageId}

Wiki-Rolle erforderlich: edit oder manage

Gibt 204 No Content zurück.

Seitenversionen abrufen

GET /api/v1/wiki/spaces/{spaceId}/pages/{pageId}/versions

Gibt die Versionshistorie einer Seite zurück.

Seitenversion wiederherstellen

POST /api/v1/wiki/spaces/{spaceId}/pages/{pageId}/versions/{versionId}/restore

Wiki-Rolle erforderlich: edit oder manage

Stellt eine vorherige Version der Seite wieder her und erstellt dabei eine neue Version.

Ordner

Ordner auflisten

GET /api/v1/wiki/spaces/{spaceId}/folders

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
parentId	string	Nein	Nach Elternordner filtern

Ordner erstellen

POST /api/v1/wiki/spaces/{spaceId}/folders

Wiki-Rolle erforderlich: edit oder manage

Request Body

Feld	Typ	Pflicht	Beschreibung
name	string	Ja	Ordnername
parentId	string	Nein	Elternordner-ID (für Verschachtelung)

Ordner abrufen

GET /api/v1/wiki/spaces/{spaceId}/folders/{folderId}

Ordner aktualisieren

PATCH /api/v1/wiki/spaces/{spaceId}/folders/{folderId}

Wiki-Rolle erforderlich: edit oder manage

Ordner löschen

DELETE /api/v1/wiki/spaces/{spaceId}/folders/{folderId}

Wiki-Rolle erforderlich: edit oder manage

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
deleteContents	boolean	Nein	Auch alle Seiten und Unterordner löschen (Standard: false)

Gibt 204 No Content zurück. Wenn deleteContents false ist und der Ordner nicht leer ist, schlägt die Anfrage fehl.

Wiki

Inhaltsverzeichnis