※ 本記事は Kibela Web API をご利用の方のみが対象です。
先日お伝えしました通り、7月1日にフォルダがグループに属するようになる変更をリリースする予定です。それに伴い、以下の Kibela Web API に非互換を伴う変更が発生します。
Kibela Web API をご利用の方は、以下の変更内容を確認の上、 非互換となる API を使っている場合は修正の準備をお願いいたします。
なお、新しい API はフォルダがグループに属するようになる機能のリリース時より使用可能となるため、それよりも前に新しい API の機能を利用しようとしても動作しませんので、ご注意ください。
変更内容
非互換を伴う API の変更は以下の通りです。
folder フィールドと FolderInput 型
今回非互換を伴う変更があった API は、ある特定のフォルダを指定する際に FolderInput 型の folder を使うようになるものが多くあります。
FolderInput 型は、
- フォルダの属するグループの ID を表す
groupIdフィールド - フォルダのパスを表す
folderNameフィールド
の2つのフィールドを持つような型です。
Mutation
createFolder
引数の CreateFolderInput に含まれる folderName フィールドが deprecated になります。
今後は folder フィールドを使用してください。
createFolderPin
引数の CreateFolderPinInput に FolderInput 型の folder フィールドが追加されました。
対象の記事が複数のフォルダに紐付いている場合、どのフォルダに対してピンするのかの指定が必須になります。
createNote
引数のcreateNoteInput に含まれる folderName フィールドが deprecated になります。
今後は folders フィールドを使用してください。
createNoteTemplate
引数の CreateNoteTemplateInput に含まれる folderFullName が deprecated になります。
今後は folders フィールドを使用してください。
removeFolderPin
引数の RemoveFolderPinInput に folder フィールドが追加されました。
対象の記事が複数のフォルダに紐付いている場合、どのフォルダに対してピンするのかの指定が必須になります。
updateNote
引数の UpdateNoteInput 内の newNote, baseNote フィールドに含まれる folderName フィールドが deprecated になります。
今後は folders フィールドを使用してください。
updateNoteFolder
updateNoteFolder API 自体が deprected になります。
今後記事の属するフォルダに関する操作を行いたい場合は、attachNoteToFolder, detachNoteFromFolder, moveNoteToAnotherFolder API を使用してください。
updateNoteTemplate
引数の UpdateNoteTemplateInput に含まれる folderFullName フィールドが deprecated になります。
今後は folders フィールドを使用してください。
Query
validateToMove
API 自体が deprecated になります。
Types
NoteTemplate
folderFullName , folderEvaluatedFullName フィールドが deprecated になります。
今後は folders フィールドを使用してください。
Note
folder, folderName フィールドが deprecated になります。
今後は folders フィールドを使用してください。
SearchResult
folder フィールドが deprecated になります。
主な非互換を伴う API の変更は以上になります。
ご質問やご要望がございましたら、お気軽に画面右下のチャットからご連絡ください！
