フォルダーをお気に入りに追加

現在のデータモデルは個人用のフォルダーのお気に入りに対応していますが、確認したウェブ版とモバイル版のファイルメニューには、フォルダー用のお気に入りに追加操作がありません。画面だけで操作するには個人用グループを使ってください。上級ユーザーはREST APIでフォルダーのポインターを作成できます。

フォルダーのお気に入りは既存のフォルダーを参照します。内容のコピー、親フォルダーの変更、追加のストレージ消費、他の人へのアクセス権の付与は行いません。

始める前に

• クライアントだけで使うショートカットが必要な場合はグループに追加を使ってください。ブラウザとモバイルのファイルメニューではフォルダーをグループに追加できます。
• POSTルートにはワークスペースIDと有効なフォルダーIDを取得してください。fullスコープとAPIアクセスがあり、同じワークスペースに固定されたBearer APIキーを使います。制限されたread、upload、clipper、wp_siteスコープではこのPOSTを実行できません。
• キーのオーナーはフォルダーに制限されていないワークスペースメンバーである必要があります。POSTはメンバーシップ、対象の可視性、対象を囲む完全ロックの連鎖を確認しますが、ロールのファイルページ権限は必要ありません。
• 結果の読み取りはより厳格です。GET /api/favouritesは制限されたメンバーを拒否し、ファイルページへのアクセス権を確認してから、表示可能でロックされていない行を返します。
• 認証情報をターミナルの履歴、スクリーンショット、サポートへのメッセージに残さないでください。

手順

1. シークレットを保護された環境変数に入れ、実際の識別子を使って次のリクエストを送信してください。

   curl --fail-with-body --request POST "https://api.dosya.dev/api/favourites" \
     -H "Authorization: Bearer $DOSYA_API_KEY" \
     -H "Content-Type: application/json" \
     --data '{"workspace_id":"ws_...","folder_id":"fld_..."}'

2. 初回の追加に成功すると、HTTP 201と、ok: trueおよび新しいお気に入り行のIDを含むオブジェクトが返されます。

3. GET /api/favourites?workspace_id=ws_…で確認してください。ロールにファイルページへのアクセス権があれば、folders配列に一致するオブジェクトが実際のfolder_id、folder_name、親ID、作成日時とともに表示されます。

4. モバイルでは、設定 → お気に入りにこのAPIが返すフォルダー行を表示できます。ブラウザのサイドバーは現在レスポンスのfiles配列だけを読むため、フォルダー項目は表示されません。

5. モバイルまたは通常のファイルのパスからフォルダーを開き、元のパンくずリストと内容を確認してください。

同じアカウントとフォルダーに2回目のPOSTを送ると、HTTP 409と「Already in favourites.」が返されます。存在しない対象や非表示の対象には「Folder not found.」が返されます。上位の完全ロックがある場合は「folder_locked」、別のワークスペースに固定された認証情報には「This API key is pinned to a different workspace.」が返されます。

結果の確認

サーバーにフォルダーの個人用お気に入り行が1件保存され、元のフォルダーは内容と権限を変えずに元の場所に残ります。GETのメンバーシップとファイルページへのアクセス確認を通過した呼び出し元はその行を読み取れます。モバイルでは返された行を表示できますが、現在のブラウザのサイドバーには表示されません。

削除は元に戻すことができ、ポインターだけに影響します。同じworkspace_idとfolder_idでDELETE /api/favouritesを呼び出してください。復元が必要な場合は再度POSTしてください。

トラブルシューティング

ファイル画面にフォルダー用の星がありません。 現在のクライアントでは正常な動作です。グループに追加を選ぶか、上記のRESTリクエストを使ってください。

フォルダーに到達する前にPOSTが拒否されます。 BearerキーにfullスコープとAPIへのアクセス権があるか確認してください。GET以外のREST操作は、ルートに明示的なより狭い指定がなければフルスコープが既定です。お気に入りのPOSTにはその指定がありません。

GETで「Not a member」またはファイルへのアクセス拒否が返されます。 ワークスペースID、キーの固定先、有効なメンバーシップ、フォルダー制限がないこと、ロールのファイルページ権限を確認してください。このGETのルールによって、成功済みのPOSTポインターが遡って無効になることはありません。

重複が報告されます。 再試行せず、既存のお気に入り行を読み取ってください。サーバーはユーザーとフォルダーの組み合わせごとにポインターを1件に制限します。

関連ガイド

• ファイルを整理する
• ファイルを検索する