Doc リファレンス

ドキュメントを整理するためのフォルダの作成・更新・一覧取得・削除を行います。フォルダはネスト可能で、parent_id を指定して階層構造を作成できます。

• GET/api/v1/docs/folders— フォルダ一覧を取得
• POST/api/v1/docs/folders— フォルダを作成
• GET/api/v1/docs/folders/{id}— フォルダを取得
• PATCH/api/v1/docs/folders/{id}— フォルダを更新
• DELETE/api/v1/docs/folders/{id}— フォルダを削除

ドキュメントの作成・更新・一覧取得・削除を行います。ドキュメントは draft / review / published / archived のステータスを持ち、更新時には自動的にバージョンが保存されます。

• GET/api/v1/docs/documents— ドキュメント一覧を取得
• POST/api/v1/docs/documents— ドキュメントを作成
• GET/api/v1/docs/documents/{id}— ドキュメントを取得
• PATCH/api/v1/docs/documents/{id}— ドキュメントを更新
• DELETE/api/v1/docs/documents/{id}— ドキュメントを削除

ドキュメントのバージョン履歴を参照します。ドキュメントを更新すると更新前の内容が自動的にバージョンとして保存されます。過去のバージョンの内容を閲覧できます。

• GET/api/v1/docs/documents/{id}/versions— バージョン一覧を取得
• GET/api/v1/docs/documents/{id}/versions/{versionId}— バージョンを取得

ドキュメントデータの変更履歴を参照します。

• GET/api/v1/docs/audit-logs— 監査ログを取得