diff --git a/compiler/datas/endpoints.json b/compiler/datas/endpoints.json index 2fce3c90..7d2bce8c 100644 --- a/compiler/datas/endpoints.json +++ b/compiler/datas/endpoints.json @@ -310,8 +310,8 @@ "/admin/resolve-abuse-user-report": { "path": "/admin/resolve-abuse-user-report", "request_body_hash": "ed9ebb3e513741301a21f71ab2927a7321f32eae633a7c5bdab6731944720ac9", - "response_body_hash": "df9c0f9df08effe88b00991f12e46077998bd6d6c3442ec518e5f463680a2c54", - "status": "supported" + "response_body_hash": "41349aaac2a09ac433ea7ea77332f0bd8ee4eaa8c4760650b4f6bc969b22f26a", + "status": "needToWork" }, "/admin/send-email": { "path": "/admin/send-email", @@ -357,7 +357,7 @@ }, "/admin/update-meta": { "path": "/admin/update-meta", - "request_body_hash": "5ad2a9a67cdc283ebe104f592bcafd3d78b58a65ea6fbc648feb5351121e6bfc", + "request_body_hash": "fcfdbe12e31a14d30897fb1317d69e22160db982d63b622f9c526806824051e0", "response_body_hash": "df9c0f9df08effe88b00991f12e46077998bd6d6c3442ec518e5f463680a2c54", "status": "needToWork" }, @@ -435,7 +435,7 @@ }, "/antennas/create": { "path": "/antennas/create", - "request_body_hash": "a71e081231fdcb86f03cdf8dce38b8d42d4ad9f67d8475e0aa4c9586740e6ddf", + "request_body_hash": "2629b07274bebee336eb94df5c6d0c1758038f086357fdf30ec0b1f93bd773f0", "response_body_hash": "bebe066a5eb4b3f00bcadb48d44888726abf162d6c35015ccb632e9fe3d0a012", "status": "notSupported" }, @@ -465,7 +465,7 @@ }, "/antennas/update": { "path": "/antennas/update", - "request_body_hash": "557d2fec6208b6da2d85823eb5a958b43cdb4abb2545542d7d16f261cace3640", + "request_body_hash": "5142c5c1059e96bdb5dde0f14c5dd8ca43d8cc6afd34d86fdff24ea6b87d48c1", "response_body_hash": "6298c6ba345854a384dc45e66ec60dd5d5d9f8f1876ebd5ff77e17a6a1af72c4", "status": "notSupported" }, @@ -1377,7 +1377,7 @@ }, "/notes/polls/recommendation": { "path": "/notes/polls/recommendation", - "request_body_hash": "ea75cb7a456fe25fc086147b7be384a2e8e51b1dfd549a4c4493fc41f2f82d2f", + "request_body_hash": "a36b89bcd88ff7d32d3ddf7b13c85a84d27468986d0134890dbab705bc096851", "response_body_hash": "b80217369b7f4ae2b7399b2fd85c03739420e9cd1a08de2ca04071642a2fc096", "status": "needToWork" }, @@ -1462,7 +1462,7 @@ "/notes/translate": { "path": "/notes/translate", "request_body_hash": "1def882b183104849c8a38b78caede0358e108a9e16dbd26f39f564beb1d87c6", - "response_body_hash": "07ef466f12e607bb59451c7400f77784b1b6bafa269657d6a228179999c42f13", + "response_body_hash": "89dcb1167ca9740ca333df288d4c1bb1d137bc6e14e47141a98bcfcc5a510f47", "status": "needToWork" }, "/notes/unrenote": { @@ -1539,7 +1539,7 @@ }, "/flash/create": { "path": "/flash/create", - "request_body_hash": "c34ab7bcdfa7507ba77f1b325efc3530720d054c6865150f15223a5aa5b69632", + "request_body_hash": "fa3339d64cce6c35581ce1fc68f4604446222bb7fca01a9c78173787e1a6a636", "response_body_hash": "65b236d4079bec9116df945a8073be7c1a6b345cb3c8bf32e2f5d3f3b0a9eab5", "status": "needToWork" }, @@ -1719,7 +1719,7 @@ }, "/users/following": { "path": "/users/following", - "request_body_hash": "599243389ea2c80889ab03636f61a4c33f44c7a753e1e7d4d16ac792acab4ccb", + "request_body_hash": "818ec9f06c34ed092e3e8848cb142164005716d251c5aee86edf22544b68d866", "response_body_hash": "36b76f2ecd5d6f2e14dd84f6fdbd334f2ef655122a521cee9996d7561ce52f3b", "status": "needToWork" }, @@ -1882,7 +1882,7 @@ "/fetch-rss": { "path": "/fetch-rss", "request_body_hash": "dd2ec4556fe76c68ffffd7b36ad89aff9fd0eb981c7b4881063a21381d96dd68", - "response_body_hash": "5ec414384d6cf9983f6015b58972a06e0e83fdd98ebd4d5feb63d156adb63a68", + "response_body_hash": "8602faafd7b9fcd8ff7da6c34d250408ac05e151b26ff1ec69df546298893461", "status": "needToWork" }, "/fetch-external-resources": { @@ -1931,7 +1931,7 @@ "path": "/admin/meta", "status": "needToWork", "request_body_hash": "44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a", - "response_body_hash": "0e2d0468d1d4ce76a8718ec6ef8b2aefe8f780162179ceb14ef85ed25d6a044a" + "response_body_hash": "fdbefdc5227175d8d0a164455e7a59e78ae63a870d444114e311975b46b2ab2b" }, "/admin/emoji/import-zip": { "path": "/admin/emoji/import-zip", @@ -2123,7 +2123,7 @@ "path": "/i/update-email", "status": "notSupported", "request_body_hash": "c2b874d747b9a4db158d40371178c6443128dce23f322e78b9e9c183649ca5ee", - "response_body_hash": "ec2a5bf5de6ddf2b1bd02032e326499676da99341d4bd35c6c0080e5a6972694" + "response_body_hash": "fe25ae0edc17429fe4d2a555ddee420edecb5d61f99b095c137082d8e78df30f" }, "/i/move": { "path": "/i/move", @@ -2208,6 +2208,72 @@ "status": "notSupported", "request_body_hash": "44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a", "response_body_hash": "df9c0f9df08effe88b00991f12e46077998bd6d6c3442ec518e5f463680a2c54" + }, + "/admin/abuse-report/notification-recipient/list": { + "path": "/admin/abuse-report/notification-recipient/list", + "status": "notSupported", + "request_body_hash": "8f1503506e2d36b4a0c2a199aa3dac352cc9c87307d49581a7f5a875d70bf6fc", + "response_body_hash": "c9900fa50f9b30515410f5d8c49ec7f9f16c3482e412044644fc0cb0700e582c" + }, + "/admin/abuse-report/notification-recipient/show": { + "path": "/admin/abuse-report/notification-recipient/show", + "status": "notSupported", + "request_body_hash": "3e47b10418dc28d7a702f3c13c8f0cd061a88803f92ad7d9009e930a8ba8d004", + "response_body_hash": "4ea053bce84713c7beaccc7dff55648e974279b5394e386db6697b9526fe1a57" + }, + "/admin/abuse-report/notification-recipient/create": { + "path": "/admin/abuse-report/notification-recipient/create", + "status": "notSupported", + "request_body_hash": "98784f268ce34b3b395ec17d6d0ba5f8f66111cb222c1aab484ea30e2f407197", + "response_body_hash": "7d4e905aa861eea671f3805b5547b0af92a0e93f2b6af6b846ded87c41593681" + }, + "/admin/abuse-report/notification-recipient/update": { + "path": "/admin/abuse-report/notification-recipient/update", + "status": "notSupported", + "request_body_hash": "0faefa4594bf7f21fe050bd414cd3b9506ffb23e8852e046b21550193c7085f4", + "response_body_hash": "7d4e905aa861eea671f3805b5547b0af92a0e93f2b6af6b846ded87c41593681" + }, + "/admin/abuse-report/notification-recipient/delete": { + "path": "/admin/abuse-report/notification-recipient/delete", + "status": "notSupported", + "request_body_hash": "3e47b10418dc28d7a702f3c13c8f0cd061a88803f92ad7d9009e930a8ba8d004", + "response_body_hash": "df9c0f9df08effe88b00991f12e46077998bd6d6c3442ec518e5f463680a2c54" + }, + "/admin/system-webhook/create": { + "path": "/admin/system-webhook/create", + "status": "notSupported", + "request_body_hash": "0abcf8a7b36b97e546c87a07d18b418758d6014fa53bbbf27332216cd7d6c685", + "response_body_hash": "8a706b3d642206f37fd2b58155b272dc8725211b8316b7455912a1bb42992edf" + }, + "/admin/system-webhook/delete": { + "path": "/admin/system-webhook/delete", + "status": "notSupported", + "request_body_hash": "3e47b10418dc28d7a702f3c13c8f0cd061a88803f92ad7d9009e930a8ba8d004", + "response_body_hash": "df9c0f9df08effe88b00991f12e46077998bd6d6c3442ec518e5f463680a2c54" + }, + "/admin/system-webhook/list": { + "path": "/admin/system-webhook/list", + "status": "notSupported", + "request_body_hash": "b0b5a8d1206b0984723951cc034fcffff2fb6d46c8740fc4d322d0010764da81", + "response_body_hash": "59c0e782f8b501d0ee1d9dbfcadf86ac845e5e1c2a878a594bd0bb65f1bbc102" + }, + "/admin/system-webhook/show": { + "path": "/admin/system-webhook/show", + "status": "notSupported", + "request_body_hash": "3e47b10418dc28d7a702f3c13c8f0cd061a88803f92ad7d9009e930a8ba8d004", + "response_body_hash": "b3e51d24fa36b875bcddf8af5aa9563773430ae9de3cc36b13fd845199a203f7" + }, + "/admin/system-webhook/update": { + "path": "/admin/system-webhook/update", + "status": "notSupported", + "request_body_hash": "83ce8e72010792b0a82d037bd8881bee476c84403c0a265a810a4776f8801e68", + "response_body_hash": "8a706b3d642206f37fd2b58155b272dc8725211b8316b7455912a1bb42992edf" + }, + "/announcements/show": { + "path": "/announcements/show", + "status": "notSupported", + "request_body_hash": "4b5386893449a8ceae9be712a28f6dba10758f1459db8dc5686a0ab08b724a15", + "response_body_hash": "ce9fa381663085cff7a855f87838e2d62cdfeb2aa4f237e50154dda5905e1013" } }, "removed": {} @@ -2220,17 +2286,17 @@ }, "UserLite": { "name": "UserLite", - "hash": "466d00c177d6076364af3a4b229dfc06313c206afa4d73be94bbc1b59c53db03", + "hash": "701ced0237e6ae2057165df2d6ecea410050b19be3b5875a248591a24eae0b12", "status": "supported" }, "UserDetailedNotMeOnly": { "name": "UserDetailedNotMeOnly", - "hash": "b5de616e11dc1686d7f22cf4e1323bffbbd55a6a9fd983f2742c8a08126c07e5", + "hash": "c0242559523abcda170011fc6bbb0c1992cd295c3a33a5c367f386ed352909af", "status": "supported" }, "MeDetailedOnly": { "name": "MeDetailedOnly", - "hash": "3a90b0f9f7a52b50d0e1e1b4d34027ce89992a08cce3b973764f735a110e0ede", + "hash": "bed2b54940d708764d029e43f96de87f7e818611d044bc1b9493f8e691a4daae", "status": "supported" }, "UserDetailedNotMe": { @@ -2255,22 +2321,22 @@ }, "UserList": { "name": "UserList", - "hash": "5259c1402c1fb77e67dfd6eaedfe3383a75837538a224ce15f2d733793c77ac3", + "hash": "0fa8055b54cc2bc9893e5fc185d3f737697adcc52cd76a667d28f4d3cc606e7f", "status": "supported" }, "Announcement": { "name": "Announcement", - "hash": "a5a93362ad8d27594b42bc86ec111e11ea302e45c30b2d0b219d5aa52dd81999", + "hash": "45fe590cf676e33180d0ecced67aa06bcc720fe2f3417052f4092362a1b94f25", "status": "supported" }, "App": { "name": "App", - "hash": "1c8addc6c7efdc356e3be846d48e6c8b2f53293d8268e737895da9ab8fae0cac", + "hash": "31d201d53c4a4d12f8a0f7e9b56b9f62db11d0caa476594cd5be08953a8dfcba", "status": "supported" }, "Note": { "name": "Note", - "hash": "ec6d0ee14cb8720876e3dbc2ecc1edf151b576328f0cade1292ef57d1f4770b5", + "hash": "1d83e8fbe8d1994519e5761df660c938f7472f72e9c966dc8f7bf8efff7f0271", "status": "supported" }, "NoteReaction": { @@ -2290,17 +2356,17 @@ }, "DriveFile": { "name": "DriveFile", - "hash": "9853a428bab9745b8e17a9c2a83231761fcda7cff883f2200e11c11b6342ce71", + "hash": "92c8c8b31bb77cdbafe853f4874a9aa643969fd1224aafea2ec5d6f2244b7c77", "status": "supported" }, "DriveFolder": { "name": "DriveFolder", - "hash": "2ee1d9098539300d5e0e5d9a367a196a8f246b323d86201ef5109b06c5ace611", + "hash": "6751202b7d4cb6f97465fcd98d21e66f4b746566a3c1d994ee0bd93fbb2aeeca", "status": "supported" }, "Following": { "name": "Following", - "hash": "98d7bf83b27127eb401200cfc66e34a63daabc3c35853fd4fa9bf0004debf1e2", + "hash": "02e9d0328a8aa661f33aaddef8cd503fddaea7e4fe999cb454e82883a03eed8b", "status": "supported" }, "Muting": { @@ -2330,12 +2396,12 @@ }, "Page": { "name": "Page", - "hash": "90f567b288015be12079ff35a50426c0b40b01caeaabe20bcc3dbb833ff764b6", + "hash": "4ad663188b59d5a6dd0c09b8566ece90d5df76940308045afcaa05d32dfc16c6", "status": "notSupported" }, "Channel": { "name": "Channel", - "hash": "65ac71d7cb329a9c3d0f4002198f6df7f525852013f84f277b447e4cde8386fd", + "hash": "c2c1c214653ab92641e031546ee1a7d2e4b17b10e92cab3d265460649533bdf4", "status": "supported" }, "QueueCount": { @@ -2345,27 +2411,27 @@ }, "Antenna": { "name": "Antenna", - "hash": "14ad7ea1c5a1ac52e744b4cff951e0dfe7a6710497d191f2756eec7436e2d8f5", + "hash": "4a9346c6704e8fa5f989eeec2eca76aa1853e1060e848aee549133b72484c04a", "status": "notSupported" }, "Clip": { "name": "Clip", - "hash": "03bd8f3b6e536386a6ee9639a90e71f4afc5c8933aeda594ca5c2ef1fa178e77", + "hash": "00bbcc85f5605a47e1726fcbefa15da9fc43209889bf095b13266f1224a7162a", "status": "notSupported" }, "FederationInstance": { "name": "FederationInstance", - "hash": "85a4b7dab56b7ba598d864d04ad5c8b8465030fc2db4147ff90ccd117fa6001f", + "hash": "9861ff0d4bf3647fe65b44403e4c46303fc9faf4272834c3772b8a22a23f6fb8", "status": "notSupported" }, "GalleryPost": { "name": "GalleryPost", - "hash": "945e43cf955886bbdb19ddbf4abb0b7b5d07f2435be2ec97129f61677a8a042c", + "hash": "37ae1b81b8e5398d4e4b9b90fffd9de0d00bd5bd4fb94c0cf4f9e25f93ab3059", "status": "supported" }, "EmojiSimple": { "name": "EmojiSimple", - "hash": "3ef42d4f73e075b2beb5a0fea0303adc1956595e1e3190a197cfc020b8d8fe3b", + "hash": "33502fae28c082cd9a837c52d1eb87f35e466f2a4f066d576176ee6d80389336", "status": "supported" }, "EmojiDetailed": { @@ -2375,7 +2441,7 @@ }, "Flash": { "name": "Flash", - "hash": "817d50ddeca96c6f0fc5ef18d48ce674c874a9b9793e5efecb325371031ab4bf", + "hash": "b3774648a293a64741dd12b89e313c273aea9caf7cb609ed2b128f76dedc8b82", "status": "notSupported" }, "Ad": { @@ -2445,7 +2511,7 @@ }, "RoleCondFormulaValue": { "name": "RoleCondFormulaValue", - "hash": "9fbf8ffad6c7c22f5b4317fcb7f75357fc9d96c53f402eeba4f66b02c5e9238b", + "hash": "4264a82a7437ee0398f55ec718b8268be5ce6072a6601d7d561c041196c9366a", "status": "notSupported" }, "RolePolicies": { @@ -2455,17 +2521,32 @@ }, "MetaLite": { "name": "MetaLite", - "hash": "ecbf6409629f7ee838ed01d0837b00b907eab7d657012003245b6e60455b0591", - "status": "notSupported" + "hash": "d6283b9b44a4e505603b4a4fa9326a49ef248616f14eccae536bf584ced67960", + "status": "supported" }, "MetaDetailedOnly": { "name": "MetaDetailedOnly", - "hash": "7c5f566abed62c97fbc3706411b61201edde599c15ac5b7f60af48dbc98528d0", - "status": "notSupported" + "hash": "79538f592fe7385a990df44f20198691b483f771e0b43fa8920ee17cea22c2d2", + "status": "supported" }, "MetaDetailed": { "name": "MetaDetailed", "hash": "55a03056b7837895f8c4458648cb70d23517d08ee3e7245243d5b784d840c5b3", + "status": "supported" + }, + "RoleCondFormulaValueUserSettingBooleanSchema": { + "name": "RoleCondFormulaValueUserSettingBooleanSchema", + "hash": "3fb0f2c3b6b0ceb644a0bf55862d90ea81d213ebcfd4ab089ca5f68260f98ecd", + "status": "notSupported" + }, + "SystemWebhook": { + "name": "SystemWebhook", + "hash": "96c34aa1a06bcc6ff6a8c53cbbec635be7c307ea8e1cdfd18595bafed612800e", + "status": "notSupported" + }, + "AbuseReportNotificationRecipient": { + "name": "AbuseReportNotificationRecipient", + "hash": "d265863c200e954705688b6e429bf6d6bda4b9fbf1fb18e718ea82308f93b43e", "status": "notSupported" } } diff --git a/compiler/datas/support_status.md b/compiler/datas/support_status.md index 35639645..16132357 100644 --- a/compiler/datas/support_status.md +++ b/compiler/datas/support_status.md @@ -2,9 +2,9 @@ ## Supported Misskey Version -`2024.3.1` +`2024.5.0-wasabi-1` -## Supported endpoints (173/368) +## Supported endpoints (173/379) - [x] /admin/accounts/create - [x] /admin/accounts/delete @@ -34,7 +34,6 @@ - [x] /admin/invite/create - [x] /admin/invite/list - [x] /admin/reset-password -- [x] /admin/resolve-abuse-user-report - [x] /admin/send-email - [x] /admin/show-moderation-logs - [x] /admin/suspend-user @@ -309,12 +308,24 @@ - [ ] /reversi/surrender - [ ] /reversi/verify - [ ] /notifications/flush +- [ ] /admin/abuse-report/notification-recipient/list +- [ ] /admin/abuse-report/notification-recipient/show +- [ ] /admin/abuse-report/notification-recipient/create +- [ ] /admin/abuse-report/notification-recipient/update +- [ ] /admin/abuse-report/notification-recipient/delete +- [ ] /admin/system-webhook/create +- [ ] /admin/system-webhook/delete +- [ ] /admin/system-webhook/list +- [ ] /admin/system-webhook/show +- [ ] /admin/system-webhook/update +- [ ] /announcements/show ## Changed request body or responses - [ ] /admin/drive/show-file (Need to work) - [ ] /admin/get-index-stats (Need to work) - [ ] /admin/get-table-stats (Need to work) +- [ ] /admin/resolve-abuse-user-report (Need to work) - [ ] /admin/update-meta (Need to work) - [ ] /drive (Need to work) - [ ] /drive/stream (Need to work) @@ -437,6 +448,9 @@ - [ ] RoleCondFormulaFollowersOrFollowingOrNotes - [ ] RoleCondFormulaValue - [ ] RolePolicies -- [ ] MetaLite -- [ ] MetaDetailedOnly -- [ ] MetaDetailed +- [x] MetaLite +- [x] MetaDetailedOnly +- [x] MetaDetailed +- [ ] RoleCondFormulaValueUserSettingBooleanSchema +- [ ] SystemWebhook +- [ ] AbuseReportNotificationRecipient diff --git a/compiler/datas/v13_api.json b/compiler/datas/v13_api.json index 45718839..ad6a3f36 100644 --- a/compiler/datas/v13_api.json +++ b/compiler/datas/v13_api.json @@ -1,7 +1,7 @@ { "openapi": "3.1.0", "info": { - "version": "2024.3.1", + "version": "2024.5.0-wasabi-1", "title": "Misskey API", "x-logo": { "url": "/static-assets/api-doc.png" } }, @@ -13,7 +13,7 @@ "paths": { "/admin/meta": { "post": { - "operationId": "admin/meta", + "operationId": "admin___meta", "summary": "admin/meta", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:meta*", "externalDocs": { @@ -142,6 +142,10 @@ "perUserHomeTimelineCacheMax": { "type": "number" }, "perUserListTimelineCacheMax": { "type": "number" }, "notesPerOneAd": { "type": "number" }, + "trustedLinkUrlPatterns": { + "type": "array", + "items": { "type": "string" } + }, "backgroundImageUrl": { "type": ["string", "null"] }, "deeplAuthKey": { "type": ["string", "null"] }, "deeplIsPro": { "type": "boolean" }, @@ -156,12 +160,23 @@ "shortName": { "type": ["string", "null"] }, "objectStorageS3ForcePathStyle": { "type": "boolean" }, "privacyPolicyUrl": { "type": ["string", "null"] }, + "inquiryUrl": { "type": ["string", "null"] }, "repositoryUrl": { "type": ["string", "null"] }, - "summalyProxy": { "type": ["string", "null"] }, + "summalyProxy": { + "type": ["string", "null"], + "deprecated": true, + "description": "[Deprecated] Use \"urlPreviewSummaryProxyUrl\" instead." + }, "themeColor": { "type": ["string", "null"] }, "tosUrl": { "type": ["string", "null"] }, "uri": { "type": "string" }, - "version": { "type": "string" } + "version": { "type": "string" }, + "urlPreviewEnabled": { "type": "boolean" }, + "urlPreviewTimeout": { "type": "number" }, + "urlPreviewMaximumContentLength": { "type": "number" }, + "urlPreviewRequireContentLength": { "type": "boolean" }, + "urlPreviewUserAgent": { "type": ["string", "null"] }, + "urlPreviewSummaryProxyUrl": { "type": ["string", "null"] } }, "required": [ "cacheRemoteFiles", @@ -242,6 +257,7 @@ "perUserHomeTimelineCacheMax", "perUserListTimelineCacheMax", "notesPerOneAd", + "trustedLinkUrlPatterns", "backgroundImageUrl", "deeplAuthKey", "deeplIsPro", @@ -256,12 +272,19 @@ "shortName", "objectStorageS3ForcePathStyle", "privacyPolicyUrl", + "inquiryUrl", "repositoryUrl", "summalyProxy", "themeColor", "tosUrl", "uri", - "version" + "version", + "urlPreviewEnabled", + "urlPreviewTimeout", + "urlPreviewMaximumContentLength", + "urlPreviewRequireContentLength", + "urlPreviewUserAgent", + "urlPreviewSummaryProxyUrl" ] } } @@ -367,7 +390,7 @@ }, "/admin/abuse-user-reports": { "post": { - "operationId": "admin/abuse-user-reports", + "operationId": "admin___abuse-user-reports", "summary": "admin/abuse-user-reports", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:abuse-user-reports*", "externalDocs": { @@ -561,16 +584,17 @@ } } }, - "/admin/accounts/create": { + "/admin/abuse-report/notification-recipient/list": { "post": { - "operationId": "admin/accounts/create", - "summary": "admin/accounts/create", - "description": "No description provided.\n\n**Credential required**: *No*", + "operationId": "admin___abuse-report___notification-recipient___list", + "summary": "admin/abuse-report/notification-recipient/list", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *read:admin:abuse-report:notification-recipient*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/accounts/create.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/list.ts" }, "tags": ["admin"], + "security": [{ "bearerAuth": [] }], "requestBody": { "required": true, "content": { @@ -578,10 +602,11 @@ "schema": { "type": "object", "properties": { - "username": { "type": "string", "pattern": "^\\w{1,20}$" }, - "password": { "type": "string", "minLength": 1 } - }, - "required": ["username", "password"] + "method": { + "type": "array", + "items": { "type": "string", "enum": ["email", "webhook"] } + } + } } } } @@ -592,10 +617,11 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { "token": { "type": "string" } }, - "required": ["token"], - "$ref": "#/components/schemas/MeDetailed" + "type": "array", + "items": { + "type": "object", + "$ref": "#/components/schemas/AbuseReportNotificationRecipient" + } } } } @@ -698,14 +724,14 @@ } } }, - "/admin/accounts/delete": { + "/admin/abuse-report/notification-recipient/show": { "post": { - "operationId": "admin/accounts/delete", - "summary": "admin/accounts/delete", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:account*", + "operationId": "admin___abuse-report___notification-recipient___show", + "summary": "admin/abuse-report/notification-recipient/show", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *read:admin:abuse-report:notification-recipient*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/accounts/delete.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/show.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -716,21 +742,42 @@ "schema": { "type": "object", "properties": { - "userId": { "type": "string", "format": "misskey:id" } + "id": { "type": "string", "format": "misskey:id" } }, - "required": ["userId"] + "required": ["id"] } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/AbuseReportNotificationRecipient" + } + } + } + }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_RECIPIENT": { + "value": { + "error": { + "message": "No such recipient.", + "code": "NO_SUCH_RECIPIENT", + "id": "013de6a8-f757-04cb-4d73-cc2a7e3368e4", + "kind": "server", + "httpStatusCode": 404 + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -823,14 +870,14 @@ } } }, - "/admin/accounts/find-by-email": { + "/admin/abuse-report/notification-recipient/create": { "post": { - "operationId": "admin/accounts/find-by-email", - "summary": "admin/accounts/find-by-email", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:account*", + "operationId": "admin___abuse-report___notification-recipient___create", + "summary": "admin/abuse-report/notification-recipient/create", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:abuse-report:notification-recipient*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/accounts/find-by-email.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/create.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -840,8 +887,21 @@ "application/json": { "schema": { "type": "object", - "properties": { "email": { "type": "string" } }, - "required": ["email"] + "properties": { + "isActive": { "type": "boolean" }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "method": { "type": "string", "enum": ["email", "webhook"] }, + "userId": { "type": "string", "format": "misskey:id" }, + "systemWebhookId": { + "type": "string", + "format": "misskey:id" + } + }, + "required": ["isActive", "name", "method"] } } } @@ -853,7 +913,7 @@ "application/json": { "schema": { "type": "object", - "$ref": "#/components/schemas/UserDetailedNotMe" + "$ref": "#/components/schemas/AbuseReportNotificationRecipient" } } } @@ -864,12 +924,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "USER_NOT_FOUND": { + "CORRELATION_CHECK_EMAIL": { "value": { "error": { - "message": "No such user who has the email address.", - "code": "USER_NOT_FOUND", - "id": "cb865949-8af5-4062-a88c-ef55e8786d1d" + "message": "If \"method\" is email, \"userId\" must be set.", + "code": "CORRELATION_CHECK_EMAIL", + "id": "348bb8ae-575a-6fe9-4327-5811999def8f", + "httpStatusCode": 400 + } + } + }, + "CORRELATION_CHECK_WEBHOOK": { + "value": { + "error": { + "message": "If \"method\" is webhook, \"systemWebhookId\" must be set.", + "code": "CORRELATION_CHECK_WEBHOOK", + "id": "b0c15051-de2d-29ef-260c-9585cddd701a", + "httpStatusCode": 400 + } + } + }, + "EMAIL_ADDRESS_NOT_SET": { + "value": { + "error": { + "message": "Email address is not set.", + "code": "EMAIL_ADDRESS_NOT_SET", + "id": "7cc1d85e-2f58-fc31-b644-3de8d0d3421f", + "httpStatusCode": 400 } } }, @@ -965,14 +1046,14 @@ } } }, - "/admin/ad/create": { + "/admin/abuse-report/notification-recipient/update": { "post": { - "operationId": "admin/ad/create", - "summary": "admin/ad/create", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:ad*", + "operationId": "admin___abuse-report___notification-recipient___update", + "summary": "admin/abuse-report/notification-recipient/update", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:abuse-report:notification-recipient*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/create.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/update.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -983,27 +1064,21 @@ "schema": { "type": "object", "properties": { - "url": { "type": "string", "minLength": 1 }, - "memo": { "type": "string" }, - "place": { "type": "string" }, - "priority": { "type": "string" }, - "ratio": { "type": "integer" }, - "expiresAt": { "type": "integer" }, - "startsAt": { "type": "integer" }, - "imageUrl": { "type": "string", "minLength": 1 }, - "dayOfWeek": { "type": "integer" } + "id": { "type": "string", "format": "misskey:id" }, + "isActive": { "type": "boolean" }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "method": { "type": "string", "enum": ["email", "webhook"] }, + "userId": { "type": "string", "format": "misskey:id" }, + "systemWebhookId": { + "type": "string", + "format": "misskey:id" + } }, - "required": [ - "url", - "memo", - "place", - "priority", - "ratio", - "expiresAt", - "startsAt", - "imageUrl", - "dayOfWeek" - ] + "required": ["id", "isActive", "name", "method"] } } } @@ -1015,7 +1090,7 @@ "application/json": { "schema": { "type": "object", - "$ref": "#/components/schemas/Ad" + "$ref": "#/components/schemas/AbuseReportNotificationRecipient" } } } @@ -1026,137 +1101,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "INVALID_PARAM": { + "CORRELATION_CHECK_EMAIL": { "value": { "error": { - "message": "Invalid param.", - "code": "INVALID_PARAM", - "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + "message": "If \"method\" is email, \"userId\" must be set.", + "code": "CORRELATION_CHECK_EMAIL", + "id": "348bb8ae-575a-6fe9-4327-5811999def8f", + "httpStatusCode": 400 } } - } - } - } - } - }, - "401": { - "description": "Authentication error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "CREDENTIAL_REQUIRED": { - "value": { - "error": { - "message": "Credential required.", - "code": "CREDENTIAL_REQUIRED", - "id": "1384574d-a912-4b81-8601-c7b1c4085df1" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "AUTHENTICATION_FAILED": { - "value": { - "error": { - "message": "Authentication failed. Please ensure your token is correct.", - "code": "AUTHENTICATION_FAILED", - "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" - } - } - } - } - } - } - }, - "418": { - "description": "I'm Ai", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "I_AM_AI": { - "value": { - "error": { - "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", - "code": "I_AM_AI", - "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" - } - } - } - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "INTERNAL_ERROR": { + }, + "CORRELATION_CHECK_WEBHOOK": { "value": { "error": { - "message": "Internal error occurred. Please contact us if the error persists.", - "code": "INTERNAL_ERROR", - "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + "message": "If \"method\" is webhook, \"systemWebhookId\" must be set.", + "code": "CORRELATION_CHECK_WEBHOOK", + "id": "b0c15051-de2d-29ef-260c-9585cddd701a", + "httpStatusCode": 400 } } - } - } - } - } - } - } - } - }, - "/admin/ad/delete": { - "post": { - "operationId": "admin/ad/delete", - "summary": "admin/ad/delete", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:ad*", - "externalDocs": { - "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/delete.ts" - }, - "tags": ["admin"], - "security": [{ "bearerAuth": [] }], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "string", "format": "misskey:id" } - }, - "required": ["id"] - } - } - } - }, - "responses": { - "204": { "description": "OK (without any results)" }, - "400": { - "description": "Client error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "NO_SUCH_AD": { + }, + "EMAIL_ADDRESS_NOT_SET": { "value": { "error": { - "message": "No such ad.", - "code": "NO_SUCH_AD", - "id": "ccac9863-3a03-416e-b899-8a64041118b1" + "message": "Email address is not set.", + "code": "EMAIL_ADDRESS_NOT_SET", + "id": "7cc1d85e-2f58-fc31-b644-3de8d0d3421f", + "httpStatusCode": 400 } } }, @@ -1252,14 +1223,14 @@ } } }, - "/admin/ad/list": { + "/admin/abuse-report/notification-recipient/delete": { "post": { - "operationId": "admin/ad/list", - "summary": "admin/ad/list", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:ad*", + "operationId": "admin___abuse-report___notification-recipient___delete", + "summary": "admin/abuse-report/notification-recipient/delete", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:abuse-report:notification-recipient*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/list.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/delete.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -1270,35 +1241,15 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 10 - }, - "sinceId": { "type": "string", "format": "misskey:id" }, - "untilId": { "type": "string", "format": "misskey:id" }, - "publishing": { "type": ["boolean", "null"], "default": null } - } + "id": { "type": "string", "format": "misskey:id" } + }, + "required": ["id"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/components/schemas/Ad" - } - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -1397,17 +1348,16 @@ } } }, - "/admin/ad/update": { + "/admin/accounts/create": { "post": { - "operationId": "admin/ad/update", - "summary": "admin/ad/update", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:ad*", + "operationId": "admin___accounts___create", + "summary": "admin/accounts/create", + "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/update.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/accounts/create.ts" }, "tags": ["admin"], - "security": [{ "bearerAuth": [] }], "requestBody": { "required": true, "content": { @@ -1415,50 +1365,34 @@ "schema": { "type": "object", "properties": { - "id": { "type": "string", "format": "misskey:id" }, - "memo": { "type": "string" }, - "url": { "type": "string", "minLength": 1 }, - "imageUrl": { "type": "string", "minLength": 1 }, - "place": { "type": "string" }, - "priority": { "type": "string" }, - "ratio": { "type": "integer" }, - "expiresAt": { "type": "integer" }, - "startsAt": { "type": "integer" }, - "dayOfWeek": { "type": "integer" } + "username": { "type": "string", "pattern": "^\\w{1,20}$" }, + "password": { "type": "string", "minLength": 1 } }, - "required": [ - "id", - "memo", - "url", - "imageUrl", - "place", - "priority", - "ratio", - "expiresAt", - "startsAt", - "dayOfWeek" - ] + "required": ["username", "password"] } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { "token": { "type": "string" } }, + "required": ["token"], + "$ref": "#/components/schemas/MeDetailed" + } + } + } + }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_AD": { - "value": { - "error": { - "message": "No such ad.", - "code": "NO_SUCH_AD", - "id": "b7aa1727-1354-47bc-a182-3a9c3973d300" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -1551,14 +1485,14 @@ } } }, - "/admin/announcements/create": { + "/admin/accounts/delete": { "post": { - "operationId": "admin/announcements/create", - "summary": "admin/announcements/create", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:announcements*", + "operationId": "admin___accounts___delete", + "summary": "admin/accounts/delete", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:account*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/create.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/accounts/delete.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -1569,70 +1503,15 @@ "schema": { "type": "object", "properties": { - "title": { "type": "string", "minLength": 1 }, - "text": { "type": "string", "minLength": 1 }, - "imageUrl": { "type": ["string", "null"], "minLength": 1 }, - "icon": { - "type": "string", - "enum": ["info", "warning", "error", "success"], - "default": "info" - }, - "display": { - "type": "string", - "enum": ["normal", "banner", "dialog"], - "default": "normal" - }, - "forExistingUsers": { "type": "boolean", "default": false }, - "silence": { "type": "boolean", "default": false }, - "needConfirmationToRead": { - "type": "boolean", - "default": false - }, - "userId": { - "type": ["string", "null"], - "format": "misskey:id", - "default": null - } + "userId": { "type": "string", "format": "misskey:id" } }, - "required": ["title", "text", "imageUrl"] + "required": ["userId"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "id", - "example": "xxxxxxxxxx" - }, - "createdAt": { "type": "string", "format": "date-time" }, - "updatedAt": { - "type": ["string", "null"], - "format": "date-time" - }, - "title": { "type": "string" }, - "text": { "type": "string" }, - "imageUrl": { "type": ["string", "null"] } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "title", - "text", - "imageUrl" - ] - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -1731,14 +1610,14 @@ } } }, - "/admin/announcements/delete": { + "/admin/accounts/find-by-email": { "post": { - "operationId": "admin/announcements/delete", - "summary": "admin/announcements/delete", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:announcements*", + "operationId": "admin___accounts___find-by-email", + "summary": "admin/accounts/find-by-email", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:account*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/delete.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/accounts/find-by-email.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -1748,28 +1627,36 @@ "application/json": { "schema": { "type": "object", - "properties": { - "id": { "type": "string", "format": "misskey:id" } - }, - "required": ["id"] + "properties": { "email": { "type": "string" } }, + "required": ["email"] } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/UserDetailedNotMe" + } + } + } + }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_ANNOUNCEMENT": { + "USER_NOT_FOUND": { "value": { "error": { - "message": "No such announcement.", - "code": "NO_SUCH_ANNOUNCEMENT", - "id": "ecad8040-a276-4e85-bda9-015a708d291e" + "message": "No such user who has the email address.", + "code": "USER_NOT_FOUND", + "id": "cb865949-8af5-4062-a88c-ef55e8786d1d" } } }, @@ -1865,14 +1752,14 @@ } } }, - "/admin/announcements/list": { + "/admin/ad/create": { "post": { - "operationId": "admin/announcements/list", - "summary": "admin/announcements/list", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:announcements*", + "operationId": "admin___ad___create", + "summary": "admin/ad/create", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:ad*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/list.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/create.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -1883,19 +1770,27 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 10 - }, - "sinceId": { "type": "string", "format": "misskey:id" }, - "untilId": { "type": "string", "format": "misskey:id" }, - "userId": { - "type": ["string", "null"], - "format": "misskey:id" - } - } + "url": { "type": "string", "minLength": 1 }, + "memo": { "type": "string" }, + "place": { "type": "string" }, + "priority": { "type": "string" }, + "ratio": { "type": "integer" }, + "expiresAt": { "type": "integer" }, + "startsAt": { "type": "integer" }, + "imageUrl": { "type": "string", "minLength": 1 }, + "dayOfWeek": { "type": "integer" } + }, + "required": [ + "url", + "memo", + "place", + "priority", + "ratio", + "expiresAt", + "startsAt", + "imageUrl", + "dayOfWeek" + ] } } } @@ -1906,35 +1801,8 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "id", - "example": "xxxxxxxxxx" - }, - "createdAt": { "type": "string", "format": "date-time" }, - "updatedAt": { - "type": ["string", "null"], - "format": "date-time" - }, - "text": { "type": "string" }, - "title": { "type": "string" }, - "imageUrl": { "type": ["string", "null"] }, - "reads": { "type": "number" } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "text", - "title", - "imageUrl", - "reads" - ] - } + "type": "object", + "$ref": "#/components/schemas/Ad" } } } @@ -2037,14 +1905,14 @@ } } }, - "/admin/announcements/update": { + "/admin/ad/delete": { "post": { - "operationId": "admin/announcements/update", - "summary": "admin/announcements/update", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:announcements*", + "operationId": "admin___ad___delete", + "summary": "admin/ad/delete", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:ad*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/update.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/delete.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -2055,22 +1923,7 @@ "schema": { "type": "object", "properties": { - "id": { "type": "string", "format": "misskey:id" }, - "title": { "type": "string", "minLength": 1 }, - "text": { "type": "string", "minLength": 1 }, - "imageUrl": { "type": ["string", "null"], "minLength": 0 }, - "icon": { - "type": "string", - "enum": ["info", "warning", "error", "success"] - }, - "display": { - "type": "string", - "enum": ["normal", "banner", "dialog"] - }, - "forExistingUsers": { "type": "boolean" }, - "silence": { "type": "boolean" }, - "needConfirmationToRead": { "type": "boolean" }, - "isActive": { "type": "boolean" } + "id": { "type": "string", "format": "misskey:id" } }, "required": ["id"] } @@ -2085,12 +1938,12 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_ANNOUNCEMENT": { + "NO_SUCH_AD": { "value": { "error": { - "message": "No such announcement.", - "code": "NO_SUCH_ANNOUNCEMENT", - "id": "d3aae5a7-6372-4cb4-b61c-f511ffc2d7cc" + "message": "No such ad.", + "code": "NO_SUCH_AD", + "id": "ccac9863-3a03-416e-b899-8a64041118b1" } } }, @@ -2186,14 +2039,14 @@ } } }, - "/admin/avatar-decorations/create": { + "/admin/ad/list": { "post": { - "operationId": "admin/avatar-decorations/create", - "summary": "admin/avatar-decorations/create", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:avatar-decorations*", + "operationId": "admin___ad___list", + "summary": "admin/ad/list", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:ad*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/avatar-decorations/create.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/list.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -2204,21 +2057,35 @@ "schema": { "type": "object", "properties": { - "name": { "type": "string", "minLength": 1 }, - "description": { "type": "string" }, - "url": { "type": "string", "minLength": 1 }, - "roleIdsThatCanBeUsedThisDecoration": { - "type": "array", - "items": { "type": "string" } - } - }, - "required": ["name", "description", "url"] + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 10 + }, + "sinceId": { "type": "string", "format": "misskey:id" }, + "untilId": { "type": "string", "format": "misskey:id" }, + "publishing": { "type": ["boolean", "null"], "default": null } + } } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/components/schemas/Ad" + } + } + } + } + }, "400": { "description": "Client error", "content": { @@ -2317,14 +2184,14 @@ } } }, - "/admin/avatar-decorations/delete": { + "/admin/ad/update": { "post": { - "operationId": "admin/avatar-decorations/delete", - "summary": "admin/avatar-decorations/delete", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:avatar-decorations*", + "operationId": "admin___ad___update", + "summary": "admin/ad/update", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:ad*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/avatar-decorations/delete.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/update.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -2335,9 +2202,29 @@ "schema": { "type": "object", "properties": { - "id": { "type": "string", "format": "misskey:id" } + "id": { "type": "string", "format": "misskey:id" }, + "memo": { "type": "string" }, + "url": { "type": "string", "minLength": 1 }, + "imageUrl": { "type": "string", "minLength": 1 }, + "place": { "type": "string" }, + "priority": { "type": "string" }, + "ratio": { "type": "integer" }, + "expiresAt": { "type": "integer" }, + "startsAt": { "type": "integer" }, + "dayOfWeek": { "type": "integer" } }, - "required": ["id"] + "required": [ + "id", + "memo", + "url", + "imageUrl", + "place", + "priority", + "ratio", + "expiresAt", + "startsAt", + "dayOfWeek" + ] } } } @@ -2350,6 +2237,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_AD": { + "value": { + "error": { + "message": "No such ad.", + "code": "NO_SUCH_AD", + "id": "b7aa1727-1354-47bc-a182-3a9c3973d300" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -2442,14 +2338,14 @@ } } }, - "/admin/avatar-decorations/list": { + "/admin/announcements/create": { "post": { - "operationId": "admin/avatar-decorations/list", - "summary": "admin/avatar-decorations/list", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:avatar-decorations*", + "operationId": "admin___announcements___create", + "summary": "admin/announcements/create", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:announcements*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/avatar-decorations/list.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/create.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -2460,19 +2356,32 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 10 + "title": { "type": "string", "minLength": 1 }, + "text": { "type": "string", "minLength": 1 }, + "imageUrl": { "type": ["string", "null"], "minLength": 1 }, + "icon": { + "type": "string", + "enum": ["info", "warning", "error", "success"], + "default": "info" + }, + "display": { + "type": "string", + "enum": ["normal", "banner", "dialog"], + "default": "normal" + }, + "forExistingUsers": { "type": "boolean", "default": false }, + "silence": { "type": "boolean", "default": false }, + "needConfirmationToRead": { + "type": "boolean", + "default": false }, - "sinceId": { "type": "string", "format": "misskey:id" }, - "untilId": { "type": "string", "format": "misskey:id" }, "userId": { "type": ["string", "null"], - "format": "misskey:id" + "format": "misskey:id", + "default": null } - } + }, + "required": ["title", "text", "imageUrl"] } } } @@ -2483,38 +2392,30 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "id", - "example": "xxxxxxxxxx" - }, - "createdAt": { "type": "string", "format": "date-time" }, - "updatedAt": { - "type": ["string", "null"], - "format": "date-time" - }, - "name": { "type": "string" }, - "description": { "type": "string" }, - "url": { "type": "string" }, - "roleIdsThatCanBeUsedThisDecoration": { - "type": "array", - "items": { "type": "string", "format": "id" } - } + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "id", + "example": "xxxxxxxxxx" }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "description", - "url", - "roleIdsThatCanBeUsedThisDecoration" - ] - } + "createdAt": { "type": "string", "format": "date-time" }, + "updatedAt": { + "type": ["string", "null"], + "format": "date-time" + }, + "title": { "type": "string" }, + "text": { "type": "string" }, + "imageUrl": { "type": ["string", "null"] } + }, + "required": [ + "id", + "createdAt", + "updatedAt", + "title", + "text", + "imageUrl" + ] } } } @@ -2617,14 +2518,14 @@ } } }, - "/admin/avatar-decorations/update": { + "/admin/announcements/delete": { "post": { - "operationId": "admin/avatar-decorations/update", - "summary": "admin/avatar-decorations/update", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:avatar-decorations*", + "operationId": "admin___announcements___delete", + "summary": "admin/announcements/delete", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:announcements*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/avatar-decorations/update.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/delete.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -2635,14 +2536,7 @@ "schema": { "type": "object", "properties": { - "id": { "type": "string", "format": "misskey:id" }, - "name": { "type": "string", "minLength": 1 }, - "description": { "type": "string" }, - "url": { "type": "string", "minLength": 1 }, - "roleIdsThatCanBeUsedThisDecoration": { - "type": "array", - "items": { "type": "string" } - } + "id": { "type": "string", "format": "misskey:id" } }, "required": ["id"] } @@ -2657,6 +2551,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_ANNOUNCEMENT": { + "value": { + "error": { + "message": "No such announcement.", + "code": "NO_SUCH_ANNOUNCEMENT", + "id": "ecad8040-a276-4e85-bda9-015a708d291e" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -2749,14 +2652,14 @@ } } }, - "/admin/delete-all-files-of-a-user": { + "/admin/announcements/list": { "post": { - "operationId": "admin/delete-all-files-of-a-user", - "summary": "admin/delete-all-files-of-a-user", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:delete-all-files-of-a-user*", + "operationId": "admin___announcements___list", + "summary": "admin/announcements/list", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:announcements*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/delete-all-files-of-a-user.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/list.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -2767,15 +2670,62 @@ "schema": { "type": "object", "properties": { - "userId": { "type": "string", "format": "misskey:id" } - }, - "required": ["userId"] + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 10 + }, + "sinceId": { "type": "string", "format": "misskey:id" }, + "untilId": { "type": "string", "format": "misskey:id" }, + "userId": { + "type": ["string", "null"], + "format": "misskey:id" + } + } } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "id", + "example": "xxxxxxxxxx" + }, + "createdAt": { "type": "string", "format": "date-time" }, + "updatedAt": { + "type": ["string", "null"], + "format": "date-time" + }, + "text": { "type": "string" }, + "title": { "type": "string" }, + "imageUrl": { "type": ["string", "null"] }, + "reads": { "type": "number" } + }, + "required": [ + "id", + "createdAt", + "updatedAt", + "text", + "title", + "imageUrl", + "reads" + ] + } + } + } + } + }, "400": { "description": "Client error", "content": { @@ -2874,14 +2824,14 @@ } } }, - "/admin/unset-user-avatar": { + "/admin/announcements/update": { "post": { - "operationId": "admin/unset-user-avatar", - "summary": "admin/unset-user-avatar", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:unset-user-avatar*", + "operationId": "admin___announcements___update", + "summary": "admin/announcements/update", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:announcements*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/unset-user-avatar.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/update.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -2892,9 +2842,24 @@ "schema": { "type": "object", "properties": { - "userId": { "type": "string", "format": "misskey:id" } + "id": { "type": "string", "format": "misskey:id" }, + "title": { "type": "string", "minLength": 1 }, + "text": { "type": "string", "minLength": 1 }, + "imageUrl": { "type": ["string", "null"], "minLength": 0 }, + "icon": { + "type": "string", + "enum": ["info", "warning", "error", "success"] + }, + "display": { + "type": "string", + "enum": ["normal", "banner", "dialog"] + }, + "forExistingUsers": { "type": "boolean" }, + "silence": { "type": "boolean" }, + "needConfirmationToRead": { "type": "boolean" }, + "isActive": { "type": "boolean" } }, - "required": ["userId"] + "required": ["id"] } } } @@ -2907,6 +2872,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_ANNOUNCEMENT": { + "value": { + "error": { + "message": "No such announcement.", + "code": "NO_SUCH_ANNOUNCEMENT", + "id": "d3aae5a7-6372-4cb4-b61c-f511ffc2d7cc" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -2999,14 +2973,14 @@ } } }, - "/admin/unset-user-banner": { + "/admin/avatar-decorations/create": { "post": { - "operationId": "admin/unset-user-banner", - "summary": "admin/unset-user-banner", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:unset-user-banner*", + "operationId": "admin___avatar-decorations___create", + "summary": "admin/avatar-decorations/create", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:avatar-decorations*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/unset-user-banner.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/avatar-decorations/create.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -3017,9 +2991,15 @@ "schema": { "type": "object", "properties": { - "userId": { "type": "string", "format": "misskey:id" } + "name": { "type": "string", "minLength": 1 }, + "description": { "type": "string" }, + "url": { "type": "string", "minLength": 1 }, + "roleIdsThatCanBeUsedThisDecoration": { + "type": "array", + "items": { "type": "string" } + } }, - "required": ["userId"] + "required": ["name", "description", "url"] } } } @@ -3124,17 +3104,31 @@ } } }, - "/admin/drive/clean-remote-files": { + "/admin/avatar-decorations/delete": { "post": { - "operationId": "admin/drive/clean-remote-files", - "summary": "admin/drive/clean-remote-files", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:drive*", + "operationId": "admin___avatar-decorations___delete", + "summary": "admin/avatar-decorations/delete", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:avatar-decorations*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/clean-remote-files.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/avatar-decorations/delete.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "misskey:id" } + }, + "required": ["id"] + } + } + } + }, "responses": { "204": { "description": "OK (without any results)" }, "400": { @@ -3235,19 +3229,83 @@ } } }, - "/admin/drive/cleanup": { + "/admin/avatar-decorations/list": { "post": { - "operationId": "admin/drive/cleanup", - "summary": "admin/drive/cleanup", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:drive*", + "operationId": "admin___avatar-decorations___list", + "summary": "admin/avatar-decorations/list", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:avatar-decorations*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/cleanup.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/avatar-decorations/list.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 10 + }, + "sinceId": { "type": "string", "format": "misskey:id" }, + "untilId": { "type": "string", "format": "misskey:id" }, + "userId": { + "type": ["string", "null"], + "format": "misskey:id" + } + } + } + } + } + }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "id", + "example": "xxxxxxxxxx" + }, + "createdAt": { "type": "string", "format": "date-time" }, + "updatedAt": { + "type": ["string", "null"], + "format": "date-time" + }, + "name": { "type": "string" }, + "description": { "type": "string" }, + "url": { "type": "string" }, + "roleIdsThatCanBeUsedThisDecoration": { + "type": "array", + "items": { "type": "string", "format": "id" } + } + }, + "required": [ + "id", + "createdAt", + "updatedAt", + "name", + "description", + "url", + "roleIdsThatCanBeUsedThisDecoration" + ] + } + } + } + } + }, "400": { "description": "Client error", "content": { @@ -3346,14 +3404,14 @@ } } }, - "/admin/drive/files": { + "/admin/avatar-decorations/update": { "post": { - "operationId": "admin/drive/files", - "summary": "admin/drive/files", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:drive*", + "operationId": "admin___avatar-decorations___update", + "summary": "admin/avatar-decorations/update", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:avatar-decorations*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/files.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/avatar-decorations/update.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -3364,52 +3422,22 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 10 - }, - "sinceId": { "type": "string", "format": "misskey:id" }, - "untilId": { "type": "string", "format": "misskey:id" }, - "userId": { - "type": ["string", "null"], - "format": "misskey:id" - }, - "type": { - "type": ["string", "null"], - "pattern": "^[a-zA-Z0-9\\/\\-*]+$" - }, - "origin": { - "type": "string", - "enum": ["combined", "local", "remote"], - "default": "local" - }, - "hostname": { - "type": ["string", "null"], - "default": null, - "description": "The local host is represented with `null`." + "id": { "type": "string", "format": "misskey:id" }, + "name": { "type": "string", "minLength": 1 }, + "description": { "type": "string" }, + "url": { "type": "string", "minLength": 1 }, + "roleIdsThatCanBeUsedThisDecoration": { + "type": "array", + "items": { "type": "string" } } - } + }, + "required": ["id"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/components/schemas/DriveFile" - } - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -3508,14 +3536,14 @@ } } }, - "/admin/drive/show-file": { + "/admin/delete-all-files-of-a-user": { "post": { - "operationId": "admin/drive/show-file", - "summary": "admin/drive/show-file", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:drive*", + "operationId": "admin___delete-all-files-of-a-user", + "summary": "admin/delete-all-files-of-a-user", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:delete-all-files-of-a-user*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/show-file.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/delete-all-files-of-a-user.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -3526,126 +3554,21 @@ "schema": { "type": "object", "properties": { - "fileId": { "type": "string", "format": "misskey:id" }, - "url": { "type": "string" } + "userId": { "type": "string", "format": "misskey:id" } }, - "anyOf": [{ "required": ["fileId"] }, { "required": ["url"] }] + "required": ["userId"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "id", - "example": "xxxxxxxxxx" - }, - "createdAt": { "type": "string", "format": "date-time" }, - "userId": { - "type": ["string", "null"], - "format": "id", - "example": "xxxxxxxxxx" - }, - "userHost": { - "type": ["string", "null"], - "description": "The local host is represented with `null`." - }, - "md5": { - "type": "string", - "format": "md5", - "example": "15eca7fba0480996e2245f5185bf39f2" - }, - "name": { "type": "string", "example": "lenna.jpg" }, - "type": { "type": "string", "example": "image/jpeg" }, - "size": { "type": "number", "example": 51469 }, - "comment": { "type": ["string", "null"] }, - "blurhash": { "type": ["string", "null"] }, - "properties": { - "type": "object", - "properties": { - "width": { "type": "number" }, - "height": { "type": "number" }, - "orientation": { "type": "number" }, - "avgColor": { "type": "string" } - } - }, - "storedInternal": { - "type": ["boolean", "null"], - "example": true - }, - "url": { "type": ["string", "null"], "format": "url" }, - "thumbnailUrl": { - "type": ["string", "null"], - "format": "url" - }, - "webpublicUrl": { - "type": ["string", "null"], - "format": "url" - }, - "accessKey": { "type": ["string", "null"] }, - "thumbnailAccessKey": { "type": ["string", "null"] }, - "webpublicAccessKey": { "type": ["string", "null"] }, - "uri": { "type": ["string", "null"] }, - "src": { "type": ["string", "null"] }, - "folderId": { - "type": ["string", "null"], - "format": "id", - "example": "xxxxxxxxxx" - }, - "isSensitive": { "type": "boolean" }, - "isLink": { "type": "boolean" } - }, - "required": [ - "id", - "createdAt", - "userId", - "userHost", - "md5", - "name", - "type", - "size", - "comment", - "blurhash", - "properties", - "storedInternal", - "url", - "thumbnailUrl", - "webpublicUrl", - "accessKey", - "thumbnailAccessKey", - "webpublicAccessKey", - "uri", - "src", - "folderId", - "isSensitive", - "isLink" - ] - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_FILE": { - "value": { - "error": { - "message": "No such file.", - "code": "NO_SUCH_FILE", - "id": "caf3ca38-c6e5-472e-a30c-b05377dcc240" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -3738,14 +3661,14 @@ } } }, - "/admin/emoji/add-aliases-bulk": { + "/admin/unset-user-avatar": { "post": { - "operationId": "admin/emoji/add-aliases-bulk", - "summary": "admin/emoji/add-aliases-bulk", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", + "operationId": "admin___unset-user-avatar", + "summary": "admin/unset-user-avatar", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:unset-user-avatar*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/add-aliases-bulk.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/unset-user-avatar.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -3756,13 +3679,9 @@ "schema": { "type": "object", "properties": { - "ids": { - "type": "array", - "items": { "type": "string", "format": "misskey:id" } - }, - "aliases": { "type": "array", "items": { "type": "string" } } + "userId": { "type": "string", "format": "misskey:id" } }, - "required": ["ids", "aliases"] + "required": ["userId"] } } } @@ -3867,14 +3786,14 @@ } } }, - "/admin/emoji/add": { + "/admin/unset-user-banner": { "post": { - "operationId": "admin/emoji/add", - "summary": "admin/emoji/add", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", + "operationId": "admin___unset-user-banner", + "summary": "admin/unset-user-banner", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:unset-user-banner*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/add.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/unset-user-banner.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -3885,62 +3804,21 @@ "schema": { "type": "object", "properties": { - "name": { "type": "string", "pattern": "^[a-zA-Z0-9_]+$" }, - "fileId": { "type": "string", "format": "misskey:id" }, - "category": { - "type": ["string", "null"], - "description": "Use `null` to reset the category." - }, - "aliases": { "type": "array", "items": { "type": "string" } }, - "license": { "type": ["string", "null"] }, - "isSensitive": { "type": "boolean" }, - "localOnly": { "type": "boolean" }, - "roleIdsThatCanBeUsedThisEmojiAsReaction": { - "type": "array", - "items": { "type": "string" } - } + "userId": { "type": "string", "format": "misskey:id" } }, - "required": ["name", "fileId"] + "required": ["userId"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "object", - "$ref": "#/components/schemas/EmojiDetailed" - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_FILE": { - "value": { - "error": { - "message": "No such file.", - "code": "NO_SUCH_FILE", - "id": "fc46b5a4-6b92-4c33-ac66-b806659bb5cf" - } - } - }, - "DUPLICATE_NAME": { - "value": { - "error": { - "message": "Duplicate name.", - "code": "DUPLICATE_NAME", - "id": "f7a3462c-4e6e-4069-8421-b9bd4f4c3975" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -4033,68 +3911,136 @@ } } }, - "/admin/emoji/copy": { + "/admin/drive/clean-remote-files": { "post": { - "operationId": "admin/emoji/copy", - "summary": "admin/emoji/copy", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", + "operationId": "admin___drive___clean-remote-files", + "summary": "admin/drive/clean-remote-files", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:drive*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/copy.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/clean-remote-files.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "emojiId": { "type": "string", "format": "misskey:id" } - }, - "required": ["emojiId"] + "responses": { + "204": { "description": "OK (without any results)" }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } } } - } - }, - "responses": { - "200": { - "description": "OK (with results)", + }, + "401": { + "description": "Authentication error", "content": { "application/json": { - "schema": { - "type": "object", - "properties": { "id": { "type": "string", "format": "id" } }, - "required": ["id"] + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } } } } }, - "400": { - "description": "Client error", + "403": { + "description": "Forbidden error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_EMOJI": { + "AUTHENTICATION_FAILED": { "value": { "error": { - "message": "No such emoji.", - "code": "NO_SUCH_EMOJI", - "id": "e2785b66-dca3-4087-9cac-b93c541cc425" + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" } } - }, - "DUPLICATE_NAME": { + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { "value": { "error": { - "message": "Duplicate name.", - "code": "DUPLICATE_NAME", - "id": "f7a3462c-4e6e-4069-8421-b9bd4f4c3975" + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" } } - }, + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/drive/cleanup": { + "post": { + "operationId": "admin___drive___cleanup", + "summary": "admin/drive/cleanup", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:drive*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/cleanup.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "responses": { + "204": { "description": "OK (without any results)" }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { "INVALID_PARAM": { "value": { "error": { @@ -4187,14 +4133,14 @@ } } }, - "/admin/emoji/delete-bulk": { + "/admin/drive/files": { "post": { - "operationId": "admin/emoji/delete-bulk", - "summary": "admin/emoji/delete-bulk", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", + "operationId": "admin___drive___files", + "summary": "admin/drive/files", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:drive*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/delete-bulk.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/files.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -4205,18 +4151,52 @@ "schema": { "type": "object", "properties": { - "ids": { - "type": "array", - "items": { "type": "string", "format": "misskey:id" } + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 10 + }, + "sinceId": { "type": "string", "format": "misskey:id" }, + "untilId": { "type": "string", "format": "misskey:id" }, + "userId": { + "type": ["string", "null"], + "format": "misskey:id" + }, + "type": { + "type": ["string", "null"], + "pattern": "^[a-zA-Z0-9\\/\\-*]+$" + }, + "origin": { + "type": "string", + "enum": ["combined", "local", "remote"], + "default": "local" + }, + "hostname": { + "type": ["string", "null"], + "default": null, + "description": "The local host is represented with `null`." } - }, - "required": ["ids"] + } } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/components/schemas/DriveFile" + } + } + } + } + }, "400": { "description": "Client error", "content": { @@ -4315,14 +4295,14 @@ } } }, - "/admin/emoji/delete": { + "/admin/drive/show-file": { "post": { - "operationId": "admin/emoji/delete", - "summary": "admin/emoji/delete", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", + "operationId": "admin___drive___show-file", + "summary": "admin/drive/show-file", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:drive*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/delete.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/show-file.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -4333,27 +4313,123 @@ "schema": { "type": "object", "properties": { - "id": { "type": "string", "format": "misskey:id" } + "fileId": { "type": "string", "format": "misskey:id" }, + "url": { "type": "string" } }, - "required": ["id"] + "anyOf": [{ "required": ["fileId"] }, { "required": ["url"] }] } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "id", + "example": "xxxxxxxxxx" + }, + "createdAt": { "type": "string", "format": "date-time" }, + "userId": { + "type": ["string", "null"], + "format": "id", + "example": "xxxxxxxxxx" + }, + "userHost": { + "type": ["string", "null"], + "description": "The local host is represented with `null`." + }, + "md5": { + "type": "string", + "format": "md5", + "example": "15eca7fba0480996e2245f5185bf39f2" + }, + "name": { "type": "string", "example": "lenna.jpg" }, + "type": { "type": "string", "example": "image/jpeg" }, + "size": { "type": "number", "example": 51469 }, + "comment": { "type": ["string", "null"] }, + "blurhash": { "type": ["string", "null"] }, + "properties": { + "type": "object", + "properties": { + "width": { "type": "number" }, + "height": { "type": "number" }, + "orientation": { "type": "number" }, + "avgColor": { "type": "string" } + } + }, + "storedInternal": { + "type": ["boolean", "null"], + "example": true + }, + "url": { "type": ["string", "null"], "format": "url" }, + "thumbnailUrl": { + "type": ["string", "null"], + "format": "url" + }, + "webpublicUrl": { + "type": ["string", "null"], + "format": "url" + }, + "accessKey": { "type": ["string", "null"] }, + "thumbnailAccessKey": { "type": ["string", "null"] }, + "webpublicAccessKey": { "type": ["string", "null"] }, + "uri": { "type": ["string", "null"] }, + "src": { "type": ["string", "null"] }, + "folderId": { + "type": ["string", "null"], + "format": "id", + "example": "xxxxxxxxxx" + }, + "isSensitive": { "type": "boolean" }, + "isLink": { "type": "boolean" } + }, + "required": [ + "id", + "createdAt", + "userId", + "userHost", + "md5", + "name", + "type", + "size", + "comment", + "blurhash", + "properties", + "storedInternal", + "url", + "thumbnailUrl", + "webpublicUrl", + "accessKey", + "thumbnailAccessKey", + "webpublicAccessKey", + "uri", + "src", + "folderId", + "isSensitive", + "isLink" + ] + } + } + } + }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_EMOJI": { + "NO_SUCH_FILE": { "value": { "error": { - "message": "No such emoji.", - "code": "NO_SUCH_EMOJI", - "id": "be83669b-773a-44b7-b1f8-e5e5170ac3c2" + "message": "No such file.", + "code": "NO_SUCH_FILE", + "id": "caf3ca38-c6e5-472e-a30c-b05377dcc240" } } }, @@ -4449,15 +4525,16 @@ } } }, - "/admin/emoji/import-zip": { + "/admin/emoji/add-aliases-bulk": { "post": { - "operationId": "admin/emoji/import-zip", - "summary": "admin/emoji/import-zip", - "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", + "operationId": "admin___emoji___add-aliases-bulk", + "summary": "admin/emoji/add-aliases-bulk", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/import-zip.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/add-aliases-bulk.ts" }, + "tags": ["admin"], "security": [{ "bearerAuth": [] }], "requestBody": { "required": true, @@ -4466,9 +4543,13 @@ "schema": { "type": "object", "properties": { - "fileId": { "type": "string", "format": "misskey:id" } + "ids": { + "type": "array", + "items": { "type": "string", "format": "misskey:id" } + }, + "aliases": { "type": "array", "items": { "type": "string" } } }, - "required": ["fileId"] + "required": ["ids", "aliases"] } } } @@ -4573,14 +4654,14 @@ } } }, - "/admin/emoji/list-remote": { + "/admin/emoji/add": { "post": { - "operationId": "admin/emoji/list-remote", - "summary": "admin/emoji/list-remote", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:emoji*", + "operationId": "admin___emoji___add", + "summary": "admin/emoji/add", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/list-remote.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/add.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -4591,21 +4672,22 @@ "schema": { "type": "object", "properties": { - "query": { "type": ["string", "null"], "default": null }, - "host": { + "name": { "type": "string", "pattern": "^[a-zA-Z0-9_]+$" }, + "fileId": { "type": "string", "format": "misskey:id" }, + "category": { "type": ["string", "null"], - "default": null, - "description": "Use `null` to represent the local host." - }, - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 10 + "description": "Use `null` to reset the category." }, - "sinceId": { "type": "string", "format": "misskey:id" }, - "untilId": { "type": "string", "format": "misskey:id" } - } + "aliases": { "type": "array", "items": { "type": "string" } }, + "license": { "type": ["string", "null"] }, + "isSensitive": { "type": "boolean" }, + "localOnly": { "type": "boolean" }, + "roleIdsThatCanBeUsedThisEmojiAsReaction": { + "type": "array", + "items": { "type": "string" } + } + }, + "required": ["name", "fileId"] } } } @@ -4616,32 +4698,8 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "type": "string", "format": "id" }, - "aliases": { - "type": "array", - "items": { "type": "string" } - }, - "name": { "type": "string" }, - "category": { "type": ["string", "null"] }, - "host": { - "type": ["string", "null"], - "description": "The local host is represented with `null`." - }, - "url": { "type": "string" } - }, - "required": [ - "id", - "aliases", - "name", - "category", - "host", - "url" - ] - } + "type": "object", + "$ref": "#/components/schemas/EmojiDetailed" } } } @@ -4652,6 +4710,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_FILE": { + "value": { + "error": { + "message": "No such file.", + "code": "NO_SUCH_FILE", + "id": "fc46b5a4-6b92-4c33-ac66-b806659bb5cf" + } + } + }, + "DUPLICATE_NAME": { + "value": { + "error": { + "message": "Duplicate name.", + "code": "DUPLICATE_NAME", + "id": "f7a3462c-4e6e-4069-8421-b9bd4f4c3975" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -4744,14 +4820,14 @@ } } }, - "/admin/emoji/list": { + "/admin/emoji/copy": { "post": { - "operationId": "admin/emoji/list", - "summary": "admin/emoji/list", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:emoji*", + "operationId": "admin___emoji___copy", + "summary": "admin/emoji/copy", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/list.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/copy.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -4762,16 +4838,9 @@ "schema": { "type": "object", "properties": { - "query": { "type": ["string", "null"], "default": null }, - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 10 - }, - "sinceId": { "type": "string", "format": "misskey:id" }, - "untilId": { "type": "string", "format": "misskey:id" } - } + "emojiId": { "type": "string", "format": "misskey:id" } + }, + "required": ["emojiId"] } } } @@ -4782,32 +4851,9 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "type": "string", "format": "id" }, - "aliases": { - "type": "array", - "items": { "type": "string" } - }, - "name": { "type": "string" }, - "category": { "type": ["string", "null"] }, - "host": { - "type": ["string", "null"], - "description": "The local host is represented with `null`. The field exists for compatibility with other API endpoints that return files." - }, - "url": { "type": "string" } - }, - "required": [ - "id", - "aliases", - "name", - "category", - "host", - "url" - ] - } + "type": "object", + "properties": { "id": { "type": "string", "format": "id" } }, + "required": ["id"] } } } @@ -4818,6 +4864,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_EMOJI": { + "value": { + "error": { + "message": "No such emoji.", + "code": "NO_SUCH_EMOJI", + "id": "e2785b66-dca3-4087-9cac-b93c541cc425" + } + } + }, + "DUPLICATE_NAME": { + "value": { + "error": { + "message": "Duplicate name.", + "code": "DUPLICATE_NAME", + "id": "f7a3462c-4e6e-4069-8421-b9bd4f4c3975" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -4910,14 +4974,14 @@ } } }, - "/admin/emoji/remove-aliases-bulk": { + "/admin/emoji/delete-bulk": { "post": { - "operationId": "admin/emoji/remove-aliases-bulk", - "summary": "admin/emoji/remove-aliases-bulk", + "operationId": "admin___emoji___delete-bulk", + "summary": "admin/emoji/delete-bulk", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/remove-aliases-bulk.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/delete-bulk.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -4931,10 +4995,9 @@ "ids": { "type": "array", "items": { "type": "string", "format": "misskey:id" } - }, - "aliases": { "type": "array", "items": { "type": "string" } } + } }, - "required": ["ids", "aliases"] + "required": ["ids"] } } } @@ -5039,14 +5102,14 @@ } } }, - "/admin/emoji/set-aliases-bulk": { + "/admin/emoji/delete": { "post": { - "operationId": "admin/emoji/set-aliases-bulk", - "summary": "admin/emoji/set-aliases-bulk", + "operationId": "admin___emoji___delete", + "summary": "admin/emoji/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/set-aliases-bulk.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/delete.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -5057,13 +5120,9 @@ "schema": { "type": "object", "properties": { - "ids": { - "type": "array", - "items": { "type": "string", "format": "misskey:id" } - }, - "aliases": { "type": "array", "items": { "type": "string" } } + "id": { "type": "string", "format": "misskey:id" } }, - "required": ["ids", "aliases"] + "required": ["id"] } } } @@ -5076,6 +5135,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_EMOJI": { + "value": { + "error": { + "message": "No such emoji.", + "code": "NO_SUCH_EMOJI", + "id": "be83669b-773a-44b7-b1f8-e5e5170ac3c2" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -5168,16 +5236,15 @@ } } }, - "/admin/emoji/set-category-bulk": { + "/admin/emoji/import-zip": { "post": { - "operationId": "admin/emoji/set-category-bulk", - "summary": "admin/emoji/set-category-bulk", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", + "operationId": "admin___emoji___import-zip", + "summary": "admin/emoji/import-zip", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/set-category-bulk.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/import-zip.ts" }, - "tags": ["admin"], "security": [{ "bearerAuth": [] }], "requestBody": { "required": true, @@ -5186,16 +5253,9 @@ "schema": { "type": "object", "properties": { - "ids": { - "type": "array", - "items": { "type": "string", "format": "misskey:id" } - }, - "category": { - "type": ["string", "null"], - "description": "Use `null` to reset the category." - } + "fileId": { "type": "string", "format": "misskey:id" } }, - "required": ["ids"] + "required": ["fileId"] } } } @@ -5300,14 +5360,14 @@ } } }, - "/admin/emoji/set-license-bulk": { + "/admin/emoji/list-remote": { "post": { - "operationId": "admin/emoji/set-license-bulk", - "summary": "admin/emoji/set-license-bulk", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", + "operationId": "admin___emoji___list-remote", + "summary": "admin/emoji/list-remote", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/set-license-bulk.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/list-remote.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -5318,194 +5378,67 @@ "schema": { "type": "object", "properties": { - "ids": { - "type": "array", - "items": { "type": "string", "format": "misskey:id" } - }, - "license": { + "query": { "type": ["string", "null"], "default": null }, + "host": { "type": ["string", "null"], - "description": "Use `null` to reset the license." - } - }, - "required": ["ids"] + "default": null, + "description": "Use `null` to represent the local host." + }, + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 10 + }, + "sinceId": { "type": "string", "format": "misskey:id" }, + "untilId": { "type": "string", "format": "misskey:id" } + } } } } }, "responses": { - "204": { "description": "OK (without any results)" }, - "400": { - "description": "Client error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "INVALID_PARAM": { - "value": { - "error": { - "message": "Invalid param.", - "code": "INVALID_PARAM", - "id": "3d81ceae-475f-4600-b2a8-2bc116157532" - } - } - } - } - } - } - }, - "401": { - "description": "Authentication error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "CREDENTIAL_REQUIRED": { - "value": { - "error": { - "message": "Credential required.", - "code": "CREDENTIAL_REQUIRED", - "id": "1384574d-a912-4b81-8601-c7b1c4085df1" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "AUTHENTICATION_FAILED": { - "value": { - "error": { - "message": "Authentication failed. Please ensure your token is correct.", - "code": "AUTHENTICATION_FAILED", - "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" - } - } - } - } - } - } - }, - "418": { - "description": "I'm Ai", + "200": { + "description": "OK (with results)", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "I_AM_AI": { - "value": { - "error": { - "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", - "code": "I_AM_AI", - "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" - } - } + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "id" }, + "aliases": { + "type": "array", + "items": { "type": "string" } + }, + "name": { "type": "string" }, + "category": { "type": ["string", "null"] }, + "host": { + "type": ["string", "null"], + "description": "The local host is represented with `null`." + }, + "url": { "type": "string" } + }, + "required": [ + "id", + "aliases", + "name", + "category", + "host", + "url" + ] } } } } }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "INTERNAL_ERROR": { - "value": { - "error": { - "message": "Internal error occurred. Please contact us if the error persists.", - "code": "INTERNAL_ERROR", - "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" - } - } - } - } - } - } - } - } - } - }, - "/admin/emoji/update": { - "post": { - "operationId": "admin/emoji/update", - "summary": "admin/emoji/update", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", - "externalDocs": { - "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/update.ts" - }, - "tags": ["admin"], - "security": [{ "bearerAuth": [] }], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "string", "format": "misskey:id" }, - "name": { "type": "string", "pattern": "^[a-zA-Z0-9_]+$" }, - "fileId": { "type": "string", "format": "misskey:id" }, - "category": { - "type": ["string", "null"], - "description": "Use `null` to reset the category." - }, - "aliases": { "type": "array", "items": { "type": "string" } }, - "license": { "type": ["string", "null"] }, - "isSensitive": { "type": "boolean" }, - "localOnly": { "type": "boolean" }, - "roleIdsThatCanBeUsedThisEmojiAsReaction": { - "type": "array", - "items": { "type": "string" } - } - }, - "anyOf": [{ "required": ["id"] }, { "required": ["name"] }] - } - } - } - }, - "responses": { - "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_EMOJI": { - "value": { - "error": { - "message": "No such emoji.", - "code": "NO_SUCH_EMOJI", - "id": "684dec9d-a8c2-4364-9aa8-456c49cb1dc8" - } - } - }, - "NO_SUCH_FILE": { - "value": { - "error": { - "message": "No such file.", - "code": "NO_SUCH_FILE", - "id": "14fb9fd9-0731-4e2f-aeb9-f09e4740333d" - } - } - }, - "SAME_NAME_EMOJI_EXISTS": { - "value": { - "error": { - "message": "Emoji that have same name already exists.", - "code": "SAME_NAME_EMOJI_EXISTS", - "id": "7180fe9d-1ee3-bff9-647d-fe9896d2ffb8" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -5598,14 +5531,14 @@ } } }, - "/admin/federation/delete-all-files": { + "/admin/emoji/list": { "post": { - "operationId": "admin/federation/delete-all-files", - "summary": "admin/federation/delete-all-files", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:federation*", + "operationId": "admin___emoji___list", + "summary": "admin/emoji/list", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/delete-all-files.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/list.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -5615,14 +5548,57 @@ "application/json": { "schema": { "type": "object", - "properties": { "host": { "type": "string" } }, - "required": ["host"] + "properties": { + "query": { "type": ["string", "null"], "default": null }, + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 10 + }, + "sinceId": { "type": "string", "format": "misskey:id" }, + "untilId": { "type": "string", "format": "misskey:id" } + } } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "id" }, + "aliases": { + "type": "array", + "items": { "type": "string" } + }, + "name": { "type": "string" }, + "category": { "type": ["string", "null"] }, + "host": { + "type": ["string", "null"], + "description": "The local host is represented with `null`. The field exists for compatibility with other API endpoints that return files." + }, + "url": { "type": "string" } + }, + "required": [ + "id", + "aliases", + "name", + "category", + "host", + "url" + ] + } + } + } + } + }, "400": { "description": "Client error", "content": { @@ -5721,14 +5697,14 @@ } } }, - "/admin/federation/refresh-remote-instance-metadata": { + "/admin/emoji/remove-aliases-bulk": { "post": { - "operationId": "admin/federation/refresh-remote-instance-metadata", - "summary": "admin/federation/refresh-remote-instance-metadata", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:federation*", + "operationId": "admin___emoji___remove-aliases-bulk", + "summary": "admin/emoji/remove-aliases-bulk", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/refresh-remote-instance-metadata.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/remove-aliases-bulk.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -5738,8 +5714,14 @@ "application/json": { "schema": { "type": "object", - "properties": { "host": { "type": "string" } }, - "required": ["host"] + "properties": { + "ids": { + "type": "array", + "items": { "type": "string", "format": "misskey:id" } + }, + "aliases": { "type": "array", "items": { "type": "string" } } + }, + "required": ["ids", "aliases"] } } } @@ -5844,14 +5826,14 @@ } } }, - "/admin/federation/remove-all-following": { + "/admin/emoji/set-aliases-bulk": { "post": { - "operationId": "admin/federation/remove-all-following", - "summary": "admin/federation/remove-all-following", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:federation*", + "operationId": "admin___emoji___set-aliases-bulk", + "summary": "admin/emoji/set-aliases-bulk", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/remove-all-following.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/set-aliases-bulk.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -5861,8 +5843,14 @@ "application/json": { "schema": { "type": "object", - "properties": { "host": { "type": "string" } }, - "required": ["host"] + "properties": { + "ids": { + "type": "array", + "items": { "type": "string", "format": "misskey:id" } + }, + "aliases": { "type": "array", "items": { "type": "string" } } + }, + "required": ["ids", "aliases"] } } } @@ -5967,14 +5955,14 @@ } } }, - "/admin/federation/update-instance": { + "/admin/emoji/set-category-bulk": { "post": { - "operationId": "admin/federation/update-instance", - "summary": "admin/federation/update-instance", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:federation*", + "operationId": "admin___emoji___set-category-bulk", + "summary": "admin/emoji/set-category-bulk", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/update-instance.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/set-category-bulk.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -5985,11 +5973,16 @@ "schema": { "type": "object", "properties": { - "host": { "type": "string" }, - "isSuspended": { "type": "boolean" }, - "moderationNote": { "type": "string" } + "ids": { + "type": "array", + "items": { "type": "string", "format": "misskey:id" } + }, + "category": { + "type": ["string", "null"], + "description": "Use `null` to reset the category." + } }, - "required": ["host"] + "required": ["ids"] } } } @@ -6094,36 +6087,40 @@ } } }, - "/admin/get-index-stats": { + "/admin/emoji/set-license-bulk": { "post": { - "operationId": "admin/get-index-stats", - "summary": "admin/get-index-stats", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:index-stats*", + "operationId": "admin___emoji___set-license-bulk", + "summary": "admin/emoji/set-license-bulk", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/get-index-stats.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/set-license-bulk.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], - "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tablename": { "type": "string" }, - "indexname": { "type": "string" } - }, - "required": ["tablename", "indexname"] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { "type": "string", "format": "misskey:id" } + }, + "license": { + "type": ["string", "null"], + "description": "Use `null` to reset the license." } - } + }, + "required": ["ids"] } } - }, + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -6222,43 +6219,80 @@ } } }, - "/admin/get-table-stats": { + "/admin/emoji/update": { "post": { - "operationId": "admin/get-table-stats", - "summary": "admin/get-table-stats", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:table-stats*", + "operationId": "admin___emoji___update", + "summary": "admin/emoji/update", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/get-table-stats.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/update.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], - "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "count": { "type": "number" }, - "size": { "type": "number" } - }, - "required": ["count", "size"] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "misskey:id" }, + "name": { "type": "string", "pattern": "^[a-zA-Z0-9_]+$" }, + "fileId": { "type": "string", "format": "misskey:id" }, + "category": { + "type": ["string", "null"], + "description": "Use `null` to reset the category." }, - "example": { "migrations": { "count": 66, "size": 32768 } } - } + "aliases": { "type": "array", "items": { "type": "string" } }, + "license": { "type": ["string", "null"] }, + "isSensitive": { "type": "boolean" }, + "localOnly": { "type": "boolean" }, + "roleIdsThatCanBeUsedThisEmojiAsReaction": { + "type": "array", + "items": { "type": "string" } + } + }, + "anyOf": [{ "required": ["id"] }, { "required": ["name"] }] } } - }, + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_EMOJI": { + "value": { + "error": { + "message": "No such emoji.", + "code": "NO_SUCH_EMOJI", + "id": "684dec9d-a8c2-4364-9aa8-456c49cb1dc8" + } + } + }, + "NO_SUCH_FILE": { + "value": { + "error": { + "message": "No such file.", + "code": "NO_SUCH_FILE", + "id": "14fb9fd9-0731-4e2f-aeb9-f09e4740333d" + } + } + }, + "SAME_NAME_EMOJI_EXISTS": { + "value": { + "error": { + "message": "Emoji that have same name already exists.", + "code": "SAME_NAME_EMOJI_EXISTS", + "id": "7180fe9d-1ee3-bff9-647d-fe9896d2ffb8" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -6351,14 +6385,14 @@ } } }, - "/admin/get-user-ips": { + "/admin/federation/delete-all-files": { "post": { - "operationId": "admin/get-user-ips", - "summary": "admin/get-user-ips", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:user-ips*", + "operationId": "admin___federation___delete-all-files", + "summary": "admin/federation/delete-all-files", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:federation*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/get-user-ips.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/delete-all-files.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -6368,33 +6402,14 @@ "application/json": { "schema": { "type": "object", - "properties": { - "userId": { "type": "string", "format": "misskey:id" } - }, - "required": ["userId"] + "properties": { "host": { "type": "string" } }, + "required": ["host"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ip": { "type": "string" }, - "createdAt": { "type": "string", "format": "date-time" } - }, - "required": ["ip", "createdAt"] - } - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -6493,14 +6508,14 @@ } } }, - "/admin/invite/create": { + "/admin/federation/refresh-remote-instance-metadata": { "post": { - "operationId": "admin/invite/create", - "summary": "admin/invite/create", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:invite-codes*", + "operationId": "admin___federation___refresh-remote-instance-metadata", + "summary": "admin/federation/refresh-remote-instance-metadata", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:federation*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/invite/create.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/refresh-remote-instance-metadata.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -6510,49 +6525,20 @@ "application/json": { "schema": { "type": "object", - "properties": { - "count": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 1 - }, - "expiresAt": { "type": ["string", "null"] } - } + "properties": { "host": { "type": "string" } }, + "required": ["host"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/components/schemas/InviteCode" - } - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "INVALID_DATE_TIME": { - "value": { - "error": { - "message": "Invalid date-time format", - "code": "INVALID_DATE_TIME", - "id": "f1380b15-3760-4c6c-a1db-5c3aaf1cbd49" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -6645,14 +6631,14 @@ } } }, - "/admin/invite/list": { + "/admin/federation/remove-all-following": { "post": { - "operationId": "admin/invite/list", - "summary": "admin/invite/list", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:invite-codes*", + "operationId": "admin___federation___remove-all-following", + "summary": "admin/federation/remove-all-following", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:federation*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/invite/list.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/remove-all-following.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -6662,43 +6648,14 @@ "application/json": { "schema": { "type": "object", - "properties": { - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - }, - "offset": { "type": "integer", "default": 0 }, - "type": { - "type": "string", - "enum": ["unused", "used", "expired", "all"], - "default": "all" - }, - "sort": { - "type": "string", - "enum": ["+createdAt", "-createdAt", "+usedAt", "-usedAt"] - } - } + "properties": { "host": { "type": "string" } }, + "required": ["host"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/components/schemas/InviteCode" - } - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -6797,14 +6754,14 @@ } } }, - "/admin/promo/create": { + "/admin/federation/update-instance": { "post": { - "operationId": "admin/promo/create", - "summary": "admin/promo/create", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:promo*", + "operationId": "admin___federation___update-instance", + "summary": "admin/federation/update-instance", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:federation*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/promo/create.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/update-instance.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -6815,10 +6772,11 @@ "schema": { "type": "object", "properties": { - "noteId": { "type": "string", "format": "misskey:id" }, - "expiresAt": { "type": "integer" } + "host": { "type": "string" }, + "isSuspended": { "type": "boolean" }, + "moderationNote": { "type": "string" } }, - "required": ["noteId", "expiresAt"] + "required": ["host"] } } } @@ -6831,24 +6789,134 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_NOTE": { + "INVALID_PARAM": { "value": { "error": { - "message": "No such note.", - "code": "NO_SUCH_NOTE", - "id": "ee449fbe-af2a-453b-9cae-cf2fe7c895fc" + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" } } - }, - "ALREADY_PROMOTED": { + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { "value": { "error": { - "message": "The note has already promoted.", - "code": "ALREADY_PROMOTED", - "id": "ae427aa2-7a41-484f-a18c-2c1104051604" + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" } } - }, + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/get-index-stats": { + "post": { + "operationId": "admin___get-index-stats", + "summary": "admin/get-index-stats", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:index-stats*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/get-index-stats.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "responses": { + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tablename": { "type": "string" }, + "indexname": { "type": "string" } + }, + "required": ["tablename", "indexname"] + } + } + } + } + }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { "INVALID_PARAM": { "value": { "error": { @@ -6941,19 +7009,37 @@ } } }, - "/admin/queue/clear": { + "/admin/get-table-stats": { "post": { - "operationId": "admin/queue/clear", - "summary": "admin/queue/clear", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:queue*", + "operationId": "admin___get-table-stats", + "summary": "admin/get-table-stats", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:table-stats*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/clear.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/get-table-stats.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "count": { "type": "number" }, + "size": { "type": "number" } + }, + "required": ["count", "size"] + }, + "example": { "migrations": { "count": 66, "size": 32768 } } + } + } + } + }, "400": { "description": "Client error", "content": { @@ -7052,17 +7138,31 @@ } } }, - "/admin/queue/deliver-delayed": { + "/admin/get-user-ips": { "post": { - "operationId": "admin/queue/deliver-delayed", - "summary": "admin/queue/deliver-delayed", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:queue*", + "operationId": "admin___get-user-ips", + "summary": "admin/get-user-ips", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:user-ips*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/deliver-delayed.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/get-user-ips.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userId": { "type": "string", "format": "misskey:id" } + }, + "required": ["userId"] + } + } + } + }, "responses": { "200": { "description": "OK (with results)", @@ -7071,12 +7171,13 @@ "schema": { "type": "array", "items": { - "type": "array", - "items": { - "anyOf": [{ "type": "string" }, { "type": "number" }] - } - }, - "example": [["example.com", 12]] + "type": "object", + "properties": { + "ip": { "type": "string" }, + "createdAt": { "type": "string", "format": "date-time" } + }, + "required": ["ip", "createdAt"] + } } } } @@ -7179,17 +7280,36 @@ } } }, - "/admin/queue/inbox-delayed": { + "/admin/invite/create": { "post": { - "operationId": "admin/queue/inbox-delayed", - "summary": "admin/queue/inbox-delayed", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:queue*", + "operationId": "admin___invite___create", + "summary": "admin/invite/create", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:invite-codes*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/inbox-delayed.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/invite/create.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 1 + }, + "expiresAt": { "type": ["string", "null"] } + } + } + } + } + }, "responses": { "200": { "description": "OK (with results)", @@ -7198,12 +7318,9 @@ "schema": { "type": "array", "items": { - "type": "array", - "items": { - "anyOf": [{ "type": "string" }, { "type": "number" }] - } - }, - "example": [["example.com", 12]] + "type": "object", + "$ref": "#/components/schemas/InviteCode" + } } } } @@ -7214,6 +7331,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "INVALID_DATE_TIME": { + "value": { + "error": { + "message": "Invalid date-time format", + "code": "INVALID_DATE_TIME", + "id": "f1380b15-3760-4c6c-a1db-5c3aaf1cbd49" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -7306,14 +7432,14 @@ } } }, - "/admin/queue/promote": { + "/admin/invite/list": { "post": { - "operationId": "admin/queue/promote", - "summary": "admin/queue/promote", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:queue*", + "operationId": "admin___invite___list", + "summary": "admin/invite/list", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:invite-codes*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/promote.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/invite/list.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -7324,15 +7450,42 @@ "schema": { "type": "object", "properties": { - "type": { "type": "string", "enum": ["deliver", "inbox"] } - }, - "required": ["type"] + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + }, + "offset": { "type": "integer", "default": 0 }, + "type": { + "type": "string", + "enum": ["unused", "used", "expired", "all"], + "default": "all" + }, + "sort": { + "type": "string", + "enum": ["+createdAt", "-createdAt", "+usedAt", "-usedAt"] + } + } } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/components/schemas/InviteCode" + } + } + } + } + }, "400": { "description": "Client error", "content": { @@ -7431,43 +7584,58 @@ } } }, - "/admin/queue/stats": { + "/admin/promo/create": { "post": { - "operationId": "admin/queue/stats", - "summary": "admin/queue/stats", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:emoji*", + "operationId": "admin___promo___create", + "summary": "admin/promo/create", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:promo*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/stats.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/promo/create.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], - "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deliver": { "$ref": "#/components/schemas/QueueCount" }, - "inbox": { "$ref": "#/components/schemas/QueueCount" }, - "db": { "$ref": "#/components/schemas/QueueCount" }, - "objectStorage": { - "$ref": "#/components/schemas/QueueCount" - } - }, - "required": ["deliver", "inbox", "db", "objectStorage"] - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "noteId": { "type": "string", "format": "misskey:id" }, + "expiresAt": { "type": "integer" } + }, + "required": ["noteId", "expiresAt"] } } - }, + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_NOTE": { + "value": { + "error": { + "message": "No such note.", + "code": "NO_SUCH_NOTE", + "id": "ee449fbe-af2a-453b-9cae-cf2fe7c895fc" + } + } + }, + "ALREADY_PROMOTED": { + "value": { + "error": { + "message": "The note has already promoted.", + "code": "ALREADY_PROMOTED", + "id": "ae427aa2-7a41-484f-a18c-2c1104051604" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -7560,65 +7728,25 @@ } } }, - "/admin/relays/add": { + "/admin/queue/clear": { "post": { - "operationId": "admin/relays/add", - "summary": "admin/relays/add", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:relays*", + "operationId": "admin___queue___clear", + "summary": "admin/queue/clear", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:queue*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/relays/add.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/clear.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { "inbox": { "type": "string" } }, - "required": ["inbox"] - } - } - } - }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "string", "format": "id" }, - "inbox": { "type": "string", "format": "url" }, - "status": { - "type": "string", - "default": "requesting", - "enum": ["requesting", "accepted", "rejected"] - } - }, - "required": ["id", "inbox", "status"] - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "INVALID_URL": { - "value": { - "error": { - "message": "Invalid URL", - "code": "INVALID_URL", - "id": "fb8c92d3-d4e5-44e7-b3d4-800d5cef8b2c" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -7711,14 +7839,14 @@ } } }, - "/admin/relays/list": { + "/admin/queue/deliver-delayed": { "post": { - "operationId": "admin/relays/list", - "summary": "admin/relays/list", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:relays*", + "operationId": "admin___queue___deliver-delayed", + "summary": "admin/queue/deliver-delayed", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:queue*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/relays/list.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/deliver-delayed.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -7730,18 +7858,12 @@ "schema": { "type": "array", "items": { - "type": "object", - "properties": { - "id": { "type": "string", "format": "id" }, - "inbox": { "type": "string", "format": "url" }, - "status": { - "type": "string", - "default": "requesting", - "enum": ["requesting", "accepted", "rejected"] - } - }, - "required": ["id", "inbox", "status"] - } + "type": "array", + "items": { + "anyOf": [{ "type": "string" }, { "type": "number" }] + } + }, + "example": [["example.com", 12]] } } } @@ -7844,31 +7966,35 @@ } } }, - "/admin/relays/remove": { + "/admin/queue/inbox-delayed": { "post": { - "operationId": "admin/relays/remove", - "summary": "admin/relays/remove", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:relays*", + "operationId": "admin___queue___inbox-delayed", + "summary": "admin/queue/inbox-delayed", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:queue*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/relays/remove.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/inbox-delayed.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { "inbox": { "type": "string" } }, - "required": ["inbox"] + "responses": { + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "array", + "items": { + "anyOf": [{ "type": "string" }, { "type": "number" }] + } + }, + "example": [["example.com", 12]] + } } } - } - }, - "responses": { - "204": { "description": "OK (without any results)" }, + }, "400": { "description": "Client error", "content": { @@ -7967,14 +8093,14 @@ } } }, - "/admin/reset-password": { + "/admin/queue/promote": { "post": { - "operationId": "admin/reset-password", - "summary": "admin/reset-password", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:reset-password*", + "operationId": "admin___queue___promote", + "summary": "admin/queue/promote", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:queue*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/reset-password.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/promote.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -7985,32 +8111,15 @@ "schema": { "type": "object", "properties": { - "userId": { "type": "string", "format": "misskey:id" } + "type": { "type": "string", "enum": ["deliver", "inbox"] } }, - "required": ["userId"] + "required": ["type"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "password": { - "type": "string", - "minLength": 8, - "maxLength": 8 - } - }, - "required": ["password"] - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -8109,34 +8218,37 @@ } } }, - "/admin/resolve-abuse-user-report": { + "/admin/queue/stats": { "post": { - "operationId": "admin/resolve-abuse-user-report", - "summary": "admin/resolve-abuse-user-report", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:resolve-abuse-user-report*", + "operationId": "admin___queue___stats", + "summary": "admin/queue/stats", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:emoji*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/resolve-abuse-user-report.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/stats.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reportId": { "type": "string", "format": "misskey:id" }, - "forward": { "type": "boolean", "default": false } - }, - "required": ["reportId"] + "responses": { + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deliver": { "$ref": "#/components/schemas/QueueCount" }, + "inbox": { "$ref": "#/components/schemas/QueueCount" }, + "db": { "$ref": "#/components/schemas/QueueCount" }, + "objectStorage": { + "$ref": "#/components/schemas/QueueCount" + } + }, + "required": ["deliver", "inbox", "db", "objectStorage"] + } } } - } - }, - "responses": { - "204": { "description": "OK (without any results)" }, + }, "400": { "description": "Client error", "content": { @@ -8235,14 +8347,14 @@ } } }, - "/admin/send-email": { + "/admin/relays/add": { "post": { - "operationId": "admin/send-email", - "summary": "admin/send-email", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:send-email*", + "operationId": "admin___relays___add", + "summary": "admin/relays/add", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:relays*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/send-email.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/relays/add.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -8252,24 +8364,48 @@ "application/json": { "schema": { "type": "object", - "properties": { - "to": { "type": "string" }, - "subject": { "type": "string" }, - "text": { "type": "string" } - }, - "required": ["to", "subject", "text"] + "properties": { "inbox": { "type": "string" } }, + "required": ["inbox"] } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "id" }, + "inbox": { "type": "string", "format": "url" }, + "status": { + "type": "string", + "default": "requesting", + "enum": ["requesting", "accepted", "rejected"] + } + }, + "required": ["id", "inbox", "status"] + } + } + } + }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "INVALID_URL": { + "value": { + "error": { + "message": "Invalid URL", + "code": "INVALID_URL", + "id": "fb8c92d3-d4e5-44e7-b3d4-800d5cef8b2c" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -8362,14 +8498,14 @@ } } }, - "/admin/server-info": { + "/admin/relays/list": { "post": { - "operationId": "admin/server-info", - "summary": "admin/server-info", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:server-info*", + "operationId": "admin___relays___list", + "summary": "admin/relays/list", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:relays*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/server-info.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/relays/list.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -8379,53 +8515,20 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "machine": { "type": "string" }, - "os": { "type": "string", "example": "linux" }, - "node": { "type": "string" }, - "psql": { "type": "string" }, - "cpu": { - "type": "object", - "properties": { - "model": { "type": "string" }, - "cores": { "type": "number" } - }, - "required": ["model", "cores"] - }, - "mem": { - "type": "object", - "properties": { - "total": { "type": "number", "format": "bytes" } - }, - "required": ["total"] - }, - "fs": { - "type": "object", - "properties": { - "total": { "type": "number", "format": "bytes" }, - "used": { "type": "number", "format": "bytes" } - }, - "required": ["total", "used"] + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "id" }, + "inbox": { "type": "string", "format": "url" }, + "status": { + "type": "string", + "default": "requesting", + "enum": ["requesting", "accepted", "rejected"] + } }, - "net": { - "type": "object", - "properties": { - "interface": { "type": "string", "example": "eth0" } - }, - "required": ["interface"] - } - }, - "required": [ - "machine", - "os", - "node", - "psql", - "cpu", - "mem", - "fs", - "net" - ] + "required": ["id", "inbox", "status"] + } } } } @@ -8528,14 +8631,14 @@ } } }, - "/admin/show-moderation-logs": { + "/admin/relays/remove": { "post": { - "operationId": "admin/show-moderation-logs", - "summary": "admin/show-moderation-logs", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:show-moderation-log*", + "operationId": "admin___relays___remove", + "summary": "admin/relays/remove", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:relays*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/show-moderation-logs.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/relays/remove.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -8545,58 +8648,14 @@ "application/json": { "schema": { "type": "object", - "properties": { - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 10 - }, - "sinceId": { "type": "string", "format": "misskey:id" }, - "untilId": { "type": "string", "format": "misskey:id" }, - "type": { "type": ["string", "null"] }, - "userId": { - "type": ["string", "null"], - "format": "misskey:id" - } - } + "properties": { "inbox": { "type": "string" } }, + "required": ["inbox"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "type": "string", "format": "id" }, - "createdAt": { "type": "string", "format": "date-time" }, - "type": { "type": "string" }, - "info": { "type": "object" }, - "userId": { "type": "string", "format": "id" }, - "user": { - "type": "object", - "$ref": "#/components/schemas/UserDetailedNotMe" - } - }, - "required": [ - "id", - "createdAt", - "type", - "info", - "userId", - "user" - ] - } - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -8695,14 +8754,14 @@ } } }, - "/admin/show-user": { + "/admin/reset-password": { "post": { - "operationId": "admin/show-user", - "summary": "admin/show-user", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:show-user*", + "operationId": "admin___reset-password", + "summary": "admin/reset-password", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:reset-password*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/show-user.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/reset-password.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -8728,114 +8787,853 @@ "schema": { "type": "object", "properties": { - "email": { "type": ["string", "null"] }, - "emailVerified": { "type": "boolean" }, - "autoAcceptFollowed": { "type": "boolean" }, - "noCrawle": { "type": "boolean" }, - "preventAiLearning": { "type": "boolean" }, - "alwaysMarkNsfw": { "type": "boolean" }, - "autoSensitive": { "type": "boolean" }, - "carefulBot": { "type": "boolean" }, - "injectFeaturedNote": { "type": "boolean" }, - "receiveAnnouncementEmail": { "type": "boolean" }, - "mutedWords": { - "type": "array", - "items": { - "anyOf": [ - { "type": "string" }, - { "type": "array", "items": { "type": "string" } } - ] + "password": { + "type": "string", + "minLength": 8, + "maxLength": 8 + } + }, + "required": ["password"] + } + } + } + }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/resolve-abuse-user-report": { + "post": { + "operationId": "admin___resolve-abuse-user-report", + "summary": "admin/resolve-abuse-user-report", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:resolve-abuse-user-report*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/resolve-abuse-user-report.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reportId": { "type": "string", "format": "misskey:id" }, + "forward": { "type": "boolean", "default": false } + }, + "required": ["reportId"] + } + } + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "NO_SUCH_ABUSE_REPORT": { + "value": { + "error": { + "message": "No such abuse report.", + "code": "NO_SUCH_ABUSE_REPORT", + "id": "ac3794dd-2ce4-d878-e546-73c60c06b398", + "kind": "server", + "httpStatusCode": 404 + } + } + }, + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/send-email": { + "post": { + "operationId": "admin___send-email", + "summary": "admin/send-email", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:send-email*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/send-email.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "to": { "type": "string" }, + "subject": { "type": "string" }, + "text": { "type": "string" } + }, + "required": ["to", "subject", "text"] + } + } + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" } + } + } + } + } + } + } + } + } + }, + "/admin/server-info": { + "post": { + "operationId": "admin___server-info", + "summary": "admin/server-info", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:server-info*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/server-info.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "responses": { + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "machine": { "type": "string" }, + "os": { "type": "string", "example": "linux" }, + "node": { "type": "string" }, + "psql": { "type": "string" }, + "cpu": { + "type": "object", + "properties": { + "model": { "type": "string" }, + "cores": { "type": "number" } + }, + "required": ["model", "cores"] }, - "mutedInstances": { - "type": "array", - "items": { "type": "string" } + "mem": { + "type": "object", + "properties": { + "total": { "type": "number", "format": "bytes" } + }, + "required": ["total"] }, - "notificationRecieveConfig": { + "fs": { "type": "object", "properties": { - "note": { - "type": "object", - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "all", - "following", - "follower", - "mutualFollow", - "followingOrFollower", - "never" - ] - } - }, - "required": ["type"] - }, - { - "type": "object", - "properties": { - "type": { "type": "string", "enum": ["list"] }, - "userListId": { - "type": "string", - "format": "misskey:id" - } - }, - "required": ["type", "userListId"] - } - ] - }, - "follow": { - "type": "object", - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "all", - "following", - "follower", - "mutualFollow", - "followingOrFollower", - "never" - ] - } - }, - "required": ["type"] - }, - { - "type": "object", - "properties": { - "type": { "type": "string", "enum": ["list"] }, - "userListId": { - "type": "string", - "format": "misskey:id" - } - }, - "required": ["type", "userListId"] - } - ] - }, - "mention": { - "type": "object", - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "all", - "following", - "follower", - "mutualFollow", - "followingOrFollower", - "never" - ] + "total": { "type": "number", "format": "bytes" }, + "used": { "type": "number", "format": "bytes" } + }, + "required": ["total", "used"] + }, + "net": { + "type": "object", + "properties": { + "interface": { "type": "string", "example": "eth0" } + }, + "required": ["interface"] + } + }, + "required": [ + "machine", + "os", + "node", + "psql", + "cpu", + "mem", + "fs", + "net" + ] + } + } + } + }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/show-moderation-logs": { + "post": { + "operationId": "admin___show-moderation-logs", + "summary": "admin/show-moderation-logs", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:show-moderation-log*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/show-moderation-logs.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 10 + }, + "sinceId": { "type": "string", "format": "misskey:id" }, + "untilId": { "type": "string", "format": "misskey:id" }, + "type": { "type": ["string", "null"] }, + "userId": { + "type": ["string", "null"], + "format": "misskey:id" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "id" }, + "createdAt": { "type": "string", "format": "date-time" }, + "type": { "type": "string" }, + "info": { "type": "object" }, + "userId": { "type": "string", "format": "id" }, + "user": { + "type": "object", + "$ref": "#/components/schemas/UserDetailedNotMe" + } + }, + "required": [ + "id", + "createdAt", + "type", + "info", + "userId", + "user" + ] + } + } + } + } + }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/show-user": { + "post": { + "operationId": "admin___show-user", + "summary": "admin/show-user", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:show-user*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/show-user.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userId": { "type": "string", "format": "misskey:id" } + }, + "required": ["userId"] + } + } + } + }, + "responses": { + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { "type": ["string", "null"] }, + "emailVerified": { "type": "boolean" }, + "autoAcceptFollowed": { "type": "boolean" }, + "noCrawle": { "type": "boolean" }, + "preventAiLearning": { "type": "boolean" }, + "alwaysMarkNsfw": { "type": "boolean" }, + "autoSensitive": { "type": "boolean" }, + "carefulBot": { "type": "boolean" }, + "injectFeaturedNote": { "type": "boolean" }, + "receiveAnnouncementEmail": { "type": "boolean" }, + "mutedWords": { + "type": "array", + "items": { + "anyOf": [ + { "type": "string" }, + { "type": "array", "items": { "type": "string" } } + ] + } + }, + "mutedInstances": { + "type": "array", + "items": { "type": "string" } + }, + "notificationRecieveConfig": { + "type": "object", + "properties": { + "note": { + "type": "object", + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "all", + "following", + "follower", + "mutualFollow", + "followingOrFollower", + "never" + ] + } + }, + "required": ["type"] + }, + { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["list"] }, + "userListId": { + "type": "string", + "format": "misskey:id" + } + }, + "required": ["type", "userListId"] + } + ] + }, + "follow": { + "type": "object", + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "all", + "following", + "follower", + "mutualFollow", + "followingOrFollower", + "never" + ] + } + }, + "required": ["type"] + }, + { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["list"] }, + "userListId": { + "type": "string", + "format": "misskey:id" + } + }, + "required": ["type", "userListId"] + } + ] + }, + "mention": { + "type": "object", + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "all", + "following", + "follower", + "mutualFollow", + "followingOrFollower", + "never" + ] } }, "required": ["type"] @@ -9217,70 +10015,1029 @@ ] } } - }, - "isModerator": { "type": "boolean" }, - "isSilenced": { "type": "boolean" }, - "isSuspended": { "type": "boolean" }, - "isHibernated": { "type": "boolean" }, - "lastActiveDate": { "type": ["string", "null"] }, - "moderationNote": { "type": "string" }, - "signins": { - "type": "array", - "items": { "$ref": "#/components/schemas/Signin" } - }, - "policies": { - "type": "object", - "$ref": "#/components/schemas/RolePolicies" - }, - "roles": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/components/schemas/Role" + }, + "isModerator": { "type": "boolean" }, + "isSilenced": { "type": "boolean" }, + "isSuspended": { "type": "boolean" }, + "isHibernated": { "type": "boolean" }, + "lastActiveDate": { "type": ["string", "null"] }, + "moderationNote": { "type": "string" }, + "signins": { + "type": "array", + "items": { "$ref": "#/components/schemas/Signin" } + }, + "policies": { + "type": "object", + "$ref": "#/components/schemas/RolePolicies" + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/components/schemas/Role" + } + }, + "roleAssigns": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { "type": "string" }, + "expiresAt": { "type": ["string", "null"] }, + "roleId": { "type": "string" } + }, + "required": ["createdAt", "expiresAt", "roleId"] + } + } + }, + "required": [ + "email", + "emailVerified", + "autoAcceptFollowed", + "noCrawle", + "preventAiLearning", + "alwaysMarkNsfw", + "autoSensitive", + "carefulBot", + "injectFeaturedNote", + "receiveAnnouncementEmail", + "mutedWords", + "mutedInstances", + "notificationRecieveConfig", + "isModerator", + "isSilenced", + "isSuspended", + "isHibernated", + "lastActiveDate", + "moderationNote", + "signins", + "policies", + "roles", + "roleAssigns" + ] + } + } + } + }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/show-users": { + "post": { + "operationId": "admin___show-users", + "summary": "admin/show-users", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:show-user*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/show-users.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 10 + }, + "offset": { "type": "integer", "default": 0 }, + "sort": { + "type": "string", + "enum": [ + "+follower", + "-follower", + "+createdAt", + "-createdAt", + "+updatedAt", + "-updatedAt", + "+lastActiveDate", + "-lastActiveDate" + ] + }, + "state": { + "type": "string", + "enum": [ + "all", + "alive", + "available", + "admin", + "moderator", + "adminOrModerator", + "suspended" + ], + "default": "all" + }, + "origin": { + "type": "string", + "enum": ["combined", "local", "remote"], + "default": "combined" + }, + "username": { "type": ["string", "null"], "default": null }, + "hostname": { + "type": ["string", "null"], + "default": null, + "description": "The local host is represented with `null`." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/components/schemas/UserDetailed" + } + } + } + } + }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/suspend-user": { + "post": { + "operationId": "admin___suspend-user", + "summary": "admin/suspend-user", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:suspend-user*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/suspend-user.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userId": { "type": "string", "format": "misskey:id" } + }, + "required": ["userId"] + } + } + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/unsuspend-user": { + "post": { + "operationId": "admin___unsuspend-user", + "summary": "admin/unsuspend-user", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:unsuspend-user*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/unsuspend-user.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userId": { "type": "string", "format": "misskey:id" } + }, + "required": ["userId"] + } + } + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/update-meta": { + "post": { + "operationId": "admin___update-meta", + "summary": "admin/update-meta", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:meta*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/update-meta.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "disableRegistration": { "type": ["boolean", "null"] }, + "pinnedUsers": { + "type": ["array", "null"], + "items": { "type": "string" } + }, + "hiddenTags": { + "type": ["array", "null"], + "items": { "type": "string" } + }, + "blockedHosts": { + "type": ["array", "null"], + "items": { "type": "string" } + }, + "sensitiveWords": { + "type": ["array", "null"], + "items": { "type": "string" } + }, + "prohibitedWords": { + "type": ["array", "null"], + "items": { "type": "string" } + }, + "themeColor": { + "type": ["string", "null"], + "pattern": "^#[0-9a-fA-F]{6}$" + }, + "mascotImageUrl": { "type": ["string", "null"] }, + "bannerUrl": { "type": ["string", "null"] }, + "serverErrorImageUrl": { "type": ["string", "null"] }, + "infoImageUrl": { "type": ["string", "null"] }, + "notFoundImageUrl": { "type": ["string", "null"] }, + "iconUrl": { "type": ["string", "null"] }, + "app192IconUrl": { "type": ["string", "null"] }, + "app512IconUrl": { "type": ["string", "null"] }, + "backgroundImageUrl": { "type": ["string", "null"] }, + "logoImageUrl": { "type": ["string", "null"] }, + "name": { "type": ["string", "null"] }, + "shortName": { "type": ["string", "null"] }, + "description": { "type": ["string", "null"] }, + "defaultLightTheme": { "type": ["string", "null"] }, + "defaultDarkTheme": { "type": ["string", "null"] }, + "cacheRemoteFiles": { "type": "boolean" }, + "cacheRemoteSensitiveFiles": { "type": "boolean" }, + "emailRequiredForSignup": { "type": "boolean" }, + "enableHcaptcha": { "type": "boolean" }, + "hcaptchaSiteKey": { "type": ["string", "null"] }, + "hcaptchaSecretKey": { "type": ["string", "null"] }, + "enableMcaptcha": { "type": "boolean" }, + "mcaptchaSiteKey": { "type": ["string", "null"] }, + "mcaptchaInstanceUrl": { "type": ["string", "null"] }, + "mcaptchaSecretKey": { "type": ["string", "null"] }, + "enableRecaptcha": { "type": "boolean" }, + "recaptchaSiteKey": { "type": ["string", "null"] }, + "recaptchaSecretKey": { "type": ["string", "null"] }, + "enableTurnstile": { "type": "boolean" }, + "turnstileSiteKey": { "type": ["string", "null"] }, + "turnstileSecretKey": { "type": ["string", "null"] }, + "sensitiveMediaDetection": { + "type": "string", + "enum": ["none", "all", "local", "remote"] + }, + "sensitiveMediaDetectionSensitivity": { + "type": "string", + "enum": ["medium", "low", "high", "veryLow", "veryHigh"] + }, + "setSensitiveFlagAutomatically": { "type": "boolean" }, + "enableSensitiveMediaDetectionForVideos": { + "type": "boolean" + }, + "proxyAccountId": { + "type": ["string", "null"], + "format": "misskey:id" + }, + "maintainerName": { "type": ["string", "null"] }, + "maintainerEmail": { "type": ["string", "null"] }, + "langs": { "type": "array", "items": { "type": "string" } }, + "deeplAuthKey": { "type": ["string", "null"] }, + "deeplIsPro": { "type": "boolean" }, + "enableEmail": { "type": "boolean" }, + "email": { "type": ["string", "null"] }, + "smtpSecure": { "type": "boolean" }, + "smtpHost": { "type": ["string", "null"] }, + "smtpPort": { "type": ["integer", "null"] }, + "smtpUser": { "type": ["string", "null"] }, + "smtpPass": { "type": ["string", "null"] }, + "enableServiceWorker": { "type": "boolean" }, + "swPublicKey": { "type": ["string", "null"] }, + "swPrivateKey": { "type": ["string", "null"] }, + "tosUrl": { "type": ["string", "null"] }, + "repositoryUrl": { "type": ["string", "null"] }, + "feedbackUrl": { "type": ["string", "null"] }, + "impressumUrl": { "type": ["string", "null"] }, + "privacyPolicyUrl": { "type": ["string", "null"] }, + "inquiryUrl": { "type": ["string", "null"] }, + "useObjectStorage": { "type": "boolean" }, + "objectStorageBaseUrl": { "type": ["string", "null"] }, + "objectStorageBucket": { "type": ["string", "null"] }, + "objectStoragePrefix": { "type": ["string", "null"] }, + "objectStorageEndpoint": { "type": ["string", "null"] }, + "objectStorageRegion": { "type": ["string", "null"] }, + "objectStoragePort": { "type": ["integer", "null"] }, + "objectStorageAccessKey": { "type": ["string", "null"] }, + "objectStorageSecretKey": { "type": ["string", "null"] }, + "objectStorageUseSSL": { "type": "boolean" }, + "objectStorageUseProxy": { "type": "boolean" }, + "objectStorageSetPublicRead": { "type": "boolean" }, + "objectStorageS3ForcePathStyle": { "type": "boolean" }, + "enableIpLogging": { "type": "boolean" }, + "enableActiveEmailValidation": { "type": "boolean" }, + "enableVerifymailApi": { "type": "boolean" }, + "verifymailAuthKey": { "type": ["string", "null"] }, + "enableTruemailApi": { "type": "boolean" }, + "truemailInstance": { "type": ["string", "null"] }, + "truemailAuthKey": { "type": ["string", "null"] }, + "enableChartsForRemoteUser": { "type": "boolean" }, + "enableChartsForFederatedInstances": { "type": "boolean" }, + "enableServerMachineStats": { "type": "boolean" }, + "enableIdenticonGeneration": { "type": "boolean" }, + "serverRules": { + "type": "array", + "items": { "type": "string" } + }, + "bannedEmailDomains": { + "type": "array", + "items": { "type": "string" } + }, + "preservedUsernames": { + "type": "array", + "items": { "type": "string" } + }, + "manifestJsonOverride": { "type": "string" }, + "enableFanoutTimeline": { "type": "boolean" }, + "enableFanoutTimelineDbFallback": { "type": "boolean" }, + "perLocalUserUserTimelineCacheMax": { "type": "integer" }, + "perRemoteUserUserTimelineCacheMax": { "type": "integer" }, + "perUserHomeTimelineCacheMax": { "type": "integer" }, + "perUserListTimelineCacheMax": { "type": "integer" }, + "notesPerOneAd": { "type": "integer" }, + "silencedHosts": { + "type": ["array", "null"], + "items": { "type": "string" } + }, + "summalyProxy": { + "type": ["string", "null"], + "description": "[Deprecated] Use \"urlPreviewSummaryProxyUrl\" instead." + }, + "trustedLinkUrlPatterns": { + "type": ["array", "null"], + "items": { "type": "string" } + }, + "urlPreviewEnabled": { "type": "boolean" }, + "urlPreviewTimeout": { "type": "integer" }, + "urlPreviewMaximumContentLength": { "type": "integer" }, + "urlPreviewRequireContentLength": { "type": "boolean" }, + "urlPreviewUserAgent": { "type": ["string", "null"] }, + "urlPreviewSummaryProxyUrl": { "type": ["string", "null"] } + } + } + } + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" } - }, - "roleAssigns": { - "type": "array", - "items": { - "type": "object", - "properties": { - "createdAt": { "type": "string" }, - "expiresAt": { "type": ["string", "null"] }, - "roleId": { "type": "string" } - }, - "required": ["createdAt", "expiresAt", "roleId"] + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" } } - }, - "required": [ - "email", - "emailVerified", - "autoAcceptFollowed", - "noCrawle", - "preventAiLearning", - "alwaysMarkNsfw", - "autoSensitive", - "carefulBot", - "injectFeaturedNote", - "receiveAnnouncementEmail", - "mutedWords", - "mutedInstances", - "notificationRecieveConfig", - "isModerator", - "isSilenced", - "isSuspended", - "isHibernated", - "lastActiveDate", - "moderationNote", - "signins", - "policies", - "roles", - "roleAssigns" - ] + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/delete-account": { + "post": { + "operationId": "admin___delete-account", + "summary": "admin/delete-account", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:delete-account*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/delete-account.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userId": { "type": "string", "format": "misskey:id" } + }, + "required": ["userId"] + } + } + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } } } } }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + } + }, + "/admin/update-user-note": { + "post": { + "operationId": "admin___update-user-note", + "summary": "admin/update-user-note", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:user-note*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/update-user-note.ts" + }, + "tags": ["admin"], + "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userId": { "type": "string", "format": "misskey:id" }, + "text": { "type": "string" } + }, + "required": ["userId", "text"] + } + } + } + }, + "responses": { + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -9379,14 +11136,14 @@ } } }, - "/admin/show-users": { + "/admin/roles/create": { "post": { - "operationId": "admin/show-users", - "summary": "admin/show-users", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:show-users*", + "operationId": "admin___roles___create", + "summary": "admin/roles/create", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/show-users.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/create.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -9397,51 +11154,39 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 10 - }, - "offset": { "type": "integer", "default": 0 }, - "sort": { - "type": "string", - "enum": [ - "+follower", - "-follower", - "+createdAt", - "-createdAt", - "+updatedAt", - "-updatedAt", - "+lastActiveDate", - "-lastActiveDate" - ] - }, - "state": { - "type": "string", - "enum": [ - "all", - "alive", - "available", - "admin", - "moderator", - "adminOrModerator", - "suspended" - ], - "default": "all" - }, - "origin": { + "name": { "type": "string" }, + "description": { "type": "string" }, + "color": { "type": ["string", "null"] }, + "iconUrl": { "type": ["string", "null"] }, + "target": { "type": "string", - "enum": ["combined", "local", "remote"], - "default": "combined" + "enum": ["manual", "conditional"] }, - "username": { "type": ["string", "null"], "default": null }, - "hostname": { - "type": ["string", "null"], - "default": null, - "description": "The local host is represented with `null`." - } - } + "condFormula": { "type": "object" }, + "isPublic": { "type": "boolean" }, + "isModerator": { "type": "boolean" }, + "isAdministrator": { "type": "boolean" }, + "isExplorable": { "type": "boolean", "default": false }, + "asBadge": { "type": "boolean" }, + "canEditMembersByModerator": { "type": "boolean" }, + "displayOrder": { "type": "number" }, + "policies": { "type": "object" } + }, + "required": [ + "name", + "description", + "color", + "iconUrl", + "target", + "condFormula", + "isPublic", + "isModerator", + "isAdministrator", + "asBadge", + "canEditMembersByModerator", + "displayOrder", + "policies" + ] } } } @@ -9452,11 +11197,8 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/components/schemas/UserDetailed" - } + "type": "object", + "$ref": "#/components/schemas/Role" } } } @@ -9559,14 +11301,14 @@ } } }, - "/admin/suspend-user": { + "/admin/roles/delete": { "post": { - "operationId": "admin/suspend-user", - "summary": "admin/suspend-user", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:suspend-user*", + "operationId": "admin___roles___delete", + "summary": "admin/roles/delete", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/suspend-user.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/delete.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -9577,9 +11319,9 @@ "schema": { "type": "object", "properties": { - "userId": { "type": "string", "format": "misskey:id" } + "roleId": { "type": "string", "format": "misskey:id" } }, - "required": ["userId"] + "required": ["roleId"] } } } @@ -9592,6 +11334,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_ROLE": { + "value": { + "error": { + "message": "No such role.", + "code": "NO_SUCH_ROLE", + "id": "de0d6ecd-8e0a-4253-88ff-74bc89ae3d45" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -9684,33 +11435,32 @@ } } }, - "/admin/unsuspend-user": { + "/admin/roles/list": { "post": { - "operationId": "admin/unsuspend-user", - "summary": "admin/unsuspend-user", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:unsuspend-user*", + "operationId": "admin___roles___list", + "summary": "admin/roles/list", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:roles*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/unsuspend-user.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/list.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "userId": { "type": "string", "format": "misskey:id" } - }, - "required": ["userId"] + "responses": { + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/components/schemas/Role" + } + } } } - } - }, - "responses": { - "204": { "description": "OK (without any results)" }, + }, "400": { "description": "Client error", "content": { @@ -9809,14 +11559,14 @@ } } }, - "/admin/update-meta": { + "/admin/roles/show": { "post": { - "operationId": "admin/update-meta", - "summary": "admin/update-meta", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:meta*", + "operationId": "admin___roles___show", + "summary": "admin/roles/show", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:roles*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/update-meta.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/show.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -9827,160 +11577,40 @@ "schema": { "type": "object", "properties": { - "disableRegistration": { "type": ["boolean", "null"] }, - "pinnedUsers": { - "type": ["array", "null"], - "items": { "type": "string" } - }, - "hiddenTags": { - "type": ["array", "null"], - "items": { "type": "string" } - }, - "blockedHosts": { - "type": ["array", "null"], - "items": { "type": "string" } - }, - "sensitiveWords": { - "type": ["array", "null"], - "items": { "type": "string" } - }, - "prohibitedWords": { - "type": ["array", "null"], - "items": { "type": "string" } - }, - "themeColor": { - "type": ["string", "null"], - "pattern": "^#[0-9a-fA-F]{6}$" - }, - "mascotImageUrl": { "type": ["string", "null"] }, - "bannerUrl": { "type": ["string", "null"] }, - "serverErrorImageUrl": { "type": ["string", "null"] }, - "infoImageUrl": { "type": ["string", "null"] }, - "notFoundImageUrl": { "type": ["string", "null"] }, - "iconUrl": { "type": ["string", "null"] }, - "app192IconUrl": { "type": ["string", "null"] }, - "app512IconUrl": { "type": ["string", "null"] }, - "backgroundImageUrl": { "type": ["string", "null"] }, - "logoImageUrl": { "type": ["string", "null"] }, - "name": { "type": ["string", "null"] }, - "shortName": { "type": ["string", "null"] }, - "description": { "type": ["string", "null"] }, - "defaultLightTheme": { "type": ["string", "null"] }, - "defaultDarkTheme": { "type": ["string", "null"] }, - "cacheRemoteFiles": { "type": "boolean" }, - "cacheRemoteSensitiveFiles": { "type": "boolean" }, - "emailRequiredForSignup": { "type": "boolean" }, - "enableHcaptcha": { "type": "boolean" }, - "hcaptchaSiteKey": { "type": ["string", "null"] }, - "hcaptchaSecretKey": { "type": ["string", "null"] }, - "enableMcaptcha": { "type": "boolean" }, - "mcaptchaSiteKey": { "type": ["string", "null"] }, - "mcaptchaInstanceUrl": { "type": ["string", "null"] }, - "mcaptchaSecretKey": { "type": ["string", "null"] }, - "enableRecaptcha": { "type": "boolean" }, - "recaptchaSiteKey": { "type": ["string", "null"] }, - "recaptchaSecretKey": { "type": ["string", "null"] }, - "enableTurnstile": { "type": "boolean" }, - "turnstileSiteKey": { "type": ["string", "null"] }, - "turnstileSecretKey": { "type": ["string", "null"] }, - "sensitiveMediaDetection": { - "type": "string", - "enum": ["none", "all", "local", "remote"] - }, - "sensitiveMediaDetectionSensitivity": { - "type": "string", - "enum": ["medium", "low", "high", "veryLow", "veryHigh"] - }, - "setSensitiveFlagAutomatically": { "type": "boolean" }, - "enableSensitiveMediaDetectionForVideos": { - "type": "boolean" - }, - "proxyAccountId": { - "type": ["string", "null"], - "format": "misskey:id" - }, - "maintainerName": { "type": ["string", "null"] }, - "maintainerEmail": { "type": ["string", "null"] }, - "langs": { "type": "array", "items": { "type": "string" } }, - "summalyProxy": { "type": ["string", "null"] }, - "deeplAuthKey": { "type": ["string", "null"] }, - "deeplIsPro": { "type": "boolean" }, - "enableEmail": { "type": "boolean" }, - "email": { "type": ["string", "null"] }, - "smtpSecure": { "type": "boolean" }, - "smtpHost": { "type": ["string", "null"] }, - "smtpPort": { "type": ["integer", "null"] }, - "smtpUser": { "type": ["string", "null"] }, - "smtpPass": { "type": ["string", "null"] }, - "enableServiceWorker": { "type": "boolean" }, - "swPublicKey": { "type": ["string", "null"] }, - "swPrivateKey": { "type": ["string", "null"] }, - "tosUrl": { "type": ["string", "null"] }, - "repositoryUrl": { "type": ["string", "null"] }, - "feedbackUrl": { "type": ["string", "null"] }, - "impressumUrl": { "type": ["string", "null"] }, - "privacyPolicyUrl": { "type": ["string", "null"] }, - "useObjectStorage": { "type": "boolean" }, - "objectStorageBaseUrl": { "type": ["string", "null"] }, - "objectStorageBucket": { "type": ["string", "null"] }, - "objectStoragePrefix": { "type": ["string", "null"] }, - "objectStorageEndpoint": { "type": ["string", "null"] }, - "objectStorageRegion": { "type": ["string", "null"] }, - "objectStoragePort": { "type": ["integer", "null"] }, - "objectStorageAccessKey": { "type": ["string", "null"] }, - "objectStorageSecretKey": { "type": ["string", "null"] }, - "objectStorageUseSSL": { "type": "boolean" }, - "objectStorageUseProxy": { "type": "boolean" }, - "objectStorageSetPublicRead": { "type": "boolean" }, - "objectStorageS3ForcePathStyle": { "type": "boolean" }, - "enableIpLogging": { "type": "boolean" }, - "enableActiveEmailValidation": { "type": "boolean" }, - "enableVerifymailApi": { "type": "boolean" }, - "verifymailAuthKey": { "type": ["string", "null"] }, - "enableTruemailApi": { "type": "boolean" }, - "truemailInstance": { "type": ["string", "null"] }, - "truemailAuthKey": { "type": ["string", "null"] }, - "enableChartsForRemoteUser": { "type": "boolean" }, - "enableChartsForFederatedInstances": { "type": "boolean" }, - "enableServerMachineStats": { "type": "boolean" }, - "enableIdenticonGeneration": { "type": "boolean" }, - "serverRules": { - "type": "array", - "items": { "type": "string" } - }, - "bannedEmailDomains": { - "type": "array", - "items": { "type": "string" } - }, - "preservedUsernames": { - "type": "array", - "items": { "type": "string" } - }, - "manifestJsonOverride": { "type": "string" }, - "enableFanoutTimeline": { "type": "boolean" }, - "enableFanoutTimelineDbFallback": { "type": "boolean" }, - "perLocalUserUserTimelineCacheMax": { "type": "integer" }, - "perRemoteUserUserTimelineCacheMax": { "type": "integer" }, - "perUserHomeTimelineCacheMax": { "type": "integer" }, - "perUserListTimelineCacheMax": { "type": "integer" }, - "notesPerOneAd": { "type": "integer" }, - "silencedHosts": { - "type": ["array", "null"], - "items": { "type": "string" } - } - } + "roleId": { "type": "string", "format": "misskey:id" } + }, + "required": ["roleId"] } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/Role" + } + } + } + }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_ROLE": { + "value": { + "error": { + "message": "No such role.", + "code": "NO_SUCH_ROLE", + "id": "07dc7d34-c0d8-49b7-96c6-db3ce64ee0b3" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -10073,14 +11703,14 @@ } } }, - "/admin/delete-account": { + "/admin/roles/update": { "post": { - "operationId": "admin/delete-account", - "summary": "admin/delete-account", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:delete-account*", + "operationId": "admin___roles___update", + "summary": "admin/roles/update", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/delete-account.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/update.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -10091,9 +11721,41 @@ "schema": { "type": "object", "properties": { - "userId": { "type": "string", "format": "misskey:id" } + "roleId": { "type": "string", "format": "misskey:id" }, + "name": { "type": "string" }, + "description": { "type": "string" }, + "color": { "type": ["string", "null"] }, + "iconUrl": { "type": ["string", "null"] }, + "target": { + "type": "string", + "enum": ["manual", "conditional"] + }, + "condFormula": { "type": "object" }, + "isPublic": { "type": "boolean" }, + "isModerator": { "type": "boolean" }, + "isAdministrator": { "type": "boolean" }, + "isExplorable": { "type": "boolean" }, + "asBadge": { "type": "boolean" }, + "canEditMembersByModerator": { "type": "boolean" }, + "displayOrder": { "type": "number" }, + "policies": { "type": "object" } }, - "required": ["userId"] + "required": [ + "roleId", + "name", + "description", + "color", + "iconUrl", + "target", + "condFormula", + "isPublic", + "isModerator", + "isAdministrator", + "asBadge", + "canEditMembersByModerator", + "displayOrder", + "policies" + ] } } } @@ -10106,6 +11768,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_ROLE": { + "value": { + "error": { + "message": "No such role.", + "code": "NO_SUCH_ROLE", + "id": "cd23ef55-09ad-428a-ac61-95a45e124b32" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -10198,14 +11869,14 @@ } } }, - "/admin/update-user-note": { + "/admin/roles/assign": { "post": { - "operationId": "admin/update-user-note", - "summary": "admin/update-user-note", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:user-note*", + "operationId": "admin___roles___assign", + "summary": "admin/roles/assign", + "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/update-user-note.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/assign.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -10216,10 +11887,11 @@ "schema": { "type": "object", "properties": { + "roleId": { "type": "string", "format": "misskey:id" }, "userId": { "type": "string", "format": "misskey:id" }, - "text": { "type": "string" } + "expiresAt": { "type": ["integer", "null"] } }, - "required": ["userId", "text"] + "required": ["roleId", "userId"] } } } @@ -10232,6 +11904,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_ROLE": { + "value": { + "error": { + "message": "No such role.", + "code": "NO_SUCH_ROLE", + "id": "6503c040-6af4-4ed9-bf07-f2dd16678eab" + } + } + }, + "NO_SUCH_USER": { + "value": { + "error": { + "message": "No such user.", + "code": "NO_SUCH_USER", + "id": "558ea170-f653-4700-94d0-5a818371d0df" + } + } + }, + "ACCESS_DENIED": { + "value": { + "error": { + "message": "Only administrators can edit members of the role.", + "code": "ACCESS_DENIED", + "id": "25b5bc31-dc79-4ebd-9bd2-c84978fd052c" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -10324,14 +12023,14 @@ } } }, - "/admin/roles/create": { + "/admin/roles/unassign": { "post": { - "operationId": "admin/roles/create", - "summary": "admin/roles/create", + "operationId": "admin___roles___unassign", + "summary": "admin/roles/unassign", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/create.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/unassign.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -10342,61 +12041,58 @@ "schema": { "type": "object", "properties": { - "name": { "type": "string" }, - "description": { "type": "string" }, - "color": { "type": ["string", "null"] }, - "iconUrl": { "type": ["string", "null"] }, - "target": { - "type": "string", - "enum": ["manual", "conditional"] - }, - "condFormula": { "type": "object" }, - "isPublic": { "type": "boolean" }, - "isModerator": { "type": "boolean" }, - "isAdministrator": { "type": "boolean" }, - "isExplorable": { "type": "boolean", "default": false }, - "asBadge": { "type": "boolean" }, - "canEditMembersByModerator": { "type": "boolean" }, - "displayOrder": { "type": "number" }, - "policies": { "type": "object" } + "roleId": { "type": "string", "format": "misskey:id" }, + "userId": { "type": "string", "format": "misskey:id" } }, - "required": [ - "name", - "description", - "color", - "iconUrl", - "target", - "condFormula", - "isPublic", - "isModerator", - "isAdministrator", - "asBadge", - "canEditMembersByModerator", - "displayOrder", - "policies" - ] + "required": ["roleId", "userId"] } } } }, "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "object", - "$ref": "#/components/schemas/Role" - } - } - } - }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_ROLE": { + "value": { + "error": { + "message": "No such role.", + "code": "NO_SUCH_ROLE", + "id": "6e519036-a70d-4c76-b679-bc8fb18194e2" + } + } + }, + "NO_SUCH_USER": { + "value": { + "error": { + "message": "No such user.", + "code": "NO_SUCH_USER", + "id": "2b730f78-1179-461b-88ad-d24c9af1a5ce" + } + } + }, + "NOT_ASSIGNED": { + "value": { + "error": { + "message": "Not assigned.", + "code": "NOT_ASSIGNED", + "id": "b9060ac7-5c94-4da4-9f55-2047c953df44" + } + } + }, + "ACCESS_DENIED": { + "value": { + "error": { + "message": "Only administrators can edit members of the role.", + "code": "ACCESS_DENIED", + "id": "24636eee-e8c1-493e-94b2-e16ad401e262" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -10489,14 +12185,14 @@ } } }, - "/admin/roles/delete": { + "/admin/roles/update-default-policies": { "post": { - "operationId": "admin/roles/delete", - "summary": "admin/roles/delete", + "operationId": "admin___roles___update-default-policies", + "summary": "admin/roles/update-default-policies", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/delete.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/update-default-policies.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -10506,10 +12202,8 @@ "application/json": { "schema": { "type": "object", - "properties": { - "roleId": { "type": "string", "format": "misskey:id" } - }, - "required": ["roleId"] + "properties": { "policies": { "type": "object" } }, + "required": ["policies"] } } } @@ -10522,15 +12216,6 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_ROLE": { - "value": { - "error": { - "message": "No such role.", - "code": "NO_SUCH_ROLE", - "id": "de0d6ecd-8e0a-4253-88ff-74bc89ae3d45" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -10623,17 +12308,38 @@ } } }, - "/admin/roles/list": { + "/admin/roles/users": { "post": { - "operationId": "admin/roles/list", - "summary": "admin/roles/list", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:roles*", + "operationId": "admin___roles___users", + "summary": "admin/roles/users", + "description": "No description provided.\n\n**Credential required**: *No* / **Permission**: *read:admin:roles*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/list.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/users.ts" }, "tags": ["admin"], - "security": [{ "bearerAuth": [] }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "roleId": { "type": "string", "format": "misskey:id" }, + "sinceId": { "type": "string", "format": "misskey:id" }, + "untilId": { "type": "string", "format": "misskey:id" }, + "limit": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 10 + } + }, + "required": ["roleId"] + } + } + } + }, "responses": { "200": { "description": "OK (with results)", @@ -10643,7 +12349,16 @@ "type": "array", "items": { "type": "object", - "$ref": "#/components/schemas/Role" + "properties": { + "id": { "type": "string", "format": "misskey:id" }, + "createdAt": { "type": "string", "format": "date-time" }, + "user": { "$ref": "#/components/schemas/UserDetailed" }, + "expiresAt": { + "type": ["string", "null"], + "format": "date-time" + } + }, + "required": ["id", "createdAt", "user", "expiresAt"] } } } @@ -10655,6 +12370,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_ROLE": { + "value": { + "error": { + "message": "No such role.", + "code": "NO_SUCH_ROLE", + "id": "224eff5e-2488-4b18-b3e7-f50d94421648" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -10747,14 +12471,14 @@ } } }, - "/admin/roles/show": { + "/admin/system-webhook/create": { "post": { - "operationId": "admin/roles/show", - "summary": "admin/roles/show", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:roles*", + "operationId": "admin___system-webhook___create", + "summary": "admin/system-webhook/create", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/show.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/system-webhook/create.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -10765,9 +12489,31 @@ "schema": { "type": "object", "properties": { - "roleId": { "type": "string", "format": "misskey:id" } + "isActive": { "type": "boolean" }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "on": { + "type": "array", + "items": { + "type": "string", + "enum": ["abuseReport", "abuseReportResolved"] + } + }, + "url": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "secret": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } }, - "required": ["roleId"] + "required": ["isActive", "name", "on", "url", "secret"] } } } @@ -10779,7 +12525,7 @@ "application/json": { "schema": { "type": "object", - "$ref": "#/components/schemas/Role" + "$ref": "#/components/schemas/SystemWebhook" } } } @@ -10790,15 +12536,6 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_ROLE": { - "value": { - "error": { - "message": "No such role.", - "code": "NO_SUCH_ROLE", - "id": "07dc7d34-c0d8-49b7-96c6-db3ce64ee0b3" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -10891,14 +12628,14 @@ } } }, - "/admin/roles/update": { + "/admin/system-webhook/delete": { "post": { - "operationId": "admin/roles/update", - "summary": "admin/roles/update", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", + "operationId": "admin___system-webhook___delete", + "summary": "admin/system-webhook/delete", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/update.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/system-webhook/delete.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -10909,41 +12646,9 @@ "schema": { "type": "object", "properties": { - "roleId": { "type": "string", "format": "misskey:id" }, - "name": { "type": "string" }, - "description": { "type": "string" }, - "color": { "type": ["string", "null"] }, - "iconUrl": { "type": ["string", "null"] }, - "target": { - "type": "string", - "enum": ["manual", "conditional"] - }, - "condFormula": { "type": "object" }, - "isPublic": { "type": "boolean" }, - "isModerator": { "type": "boolean" }, - "isAdministrator": { "type": "boolean" }, - "isExplorable": { "type": "boolean" }, - "asBadge": { "type": "boolean" }, - "canEditMembersByModerator": { "type": "boolean" }, - "displayOrder": { "type": "number" }, - "policies": { "type": "object" } + "id": { "type": "string", "format": "misskey:id" } }, - "required": [ - "roleId", - "name", - "description", - "color", - "iconUrl", - "target", - "condFormula", - "isPublic", - "isModerator", - "isAdministrator", - "asBadge", - "canEditMembersByModerator", - "displayOrder", - "policies" - ] + "required": ["id"] } } } @@ -10956,15 +12661,6 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_ROLE": { - "value": { - "error": { - "message": "No such role.", - "code": "NO_SUCH_ROLE", - "id": "cd23ef55-09ad-428a-ac61-95a45e124b32" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -11057,14 +12753,14 @@ } } }, - "/admin/roles/assign": { + "/admin/system-webhook/list": { "post": { - "operationId": "admin/roles/assign", - "summary": "admin/roles/assign", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", + "operationId": "admin___system-webhook___list", + "summary": "admin/system-webhook/list", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/assign.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/system-webhook/list.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -11075,50 +12771,40 @@ "schema": { "type": "object", "properties": { - "roleId": { "type": "string", "format": "misskey:id" }, - "userId": { "type": "string", "format": "misskey:id" }, - "expiresAt": { "type": ["integer", "null"] } - }, - "required": ["roleId", "userId"] + "isActive": { "type": "boolean" }, + "on": { + "type": "array", + "items": { + "type": "string", + "enum": ["abuseReport", "abuseReportResolved"] + } + } + } } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/components/schemas/SystemWebhook" + } + } + } + } + }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_ROLE": { - "value": { - "error": { - "message": "No such role.", - "code": "NO_SUCH_ROLE", - "id": "6503c040-6af4-4ed9-bf07-f2dd16678eab" - } - } - }, - "NO_SUCH_USER": { - "value": { - "error": { - "message": "No such user.", - "code": "NO_SUCH_USER", - "id": "558ea170-f653-4700-94d0-5a818371d0df" - } - } - }, - "ACCESS_DENIED": { - "value": { - "error": { - "message": "Only administrators can edit members of the role.", - "code": "ACCESS_DENIED", - "id": "25b5bc31-dc79-4ebd-9bd2-c84978fd052c" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -11211,14 +12897,14 @@ } } }, - "/admin/roles/unassign": { + "/admin/system-webhook/show": { "post": { - "operationId": "admin/roles/unassign", - "summary": "admin/roles/unassign", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", + "operationId": "admin___system-webhook___show", + "summary": "admin/system-webhook/show", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/unassign.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/system-webhook/show.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -11229,55 +12915,39 @@ "schema": { "type": "object", "properties": { - "roleId": { "type": "string", "format": "misskey:id" }, - "userId": { "type": "string", "format": "misskey:id" } + "id": { "type": "string", "format": "misskey:id" } }, - "required": ["roleId", "userId"] + "required": ["id"] } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/SystemWebhook" + } + } + } + }, "400": { "description": "Client error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_ROLE": { + "NO_SUCH_SYSTEM_WEBHOOK": { "value": { "error": { - "message": "No such role.", - "code": "NO_SUCH_ROLE", - "id": "6e519036-a70d-4c76-b679-bc8fb18194e2" - } - } - }, - "NO_SUCH_USER": { - "value": { - "error": { - "message": "No such user.", - "code": "NO_SUCH_USER", - "id": "2b730f78-1179-461b-88ad-d24c9af1a5ce" - } - } - }, - "NOT_ASSIGNED": { - "value": { - "error": { - "message": "Not assigned.", - "code": "NOT_ASSIGNED", - "id": "b9060ac7-5c94-4da4-9f55-2047c953df44" - } - } - }, - "ACCESS_DENIED": { - "value": { - "error": { - "message": "Only administrators can edit members of the role.", - "code": "ACCESS_DENIED", - "id": "24636eee-e8c1-493e-94b2-e16ad401e262" + "message": "No such SystemWebhook.", + "code": "NO_SUCH_SYSTEM_WEBHOOK", + "id": "38dd1ffe-04b4-6ff5-d8ba-4e6a6ae22c9d", + "kind": "server", + "httpStatusCode": 404 } } }, @@ -11373,14 +13043,14 @@ } } }, - "/admin/roles/update-default-policies": { + "/admin/system-webhook/update": { "post": { - "operationId": "admin/roles/update-default-policies", - "summary": "admin/roles/update-default-policies", - "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:roles*", + "operationId": "admin___system-webhook___update", + "summary": "admin/system-webhook/update", + "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/update-default-policies.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/system-webhook/update.ts" }, "tags": ["admin"], "security": [{ "bearerAuth": [] }], @@ -11390,14 +13060,49 @@ "application/json": { "schema": { "type": "object", - "properties": { "policies": { "type": "object" } }, - "required": ["policies"] + "properties": { + "id": { "type": "string", "format": "misskey:id" }, + "isActive": { "type": "boolean" }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "on": { + "type": "array", + "items": { + "type": "string", + "enum": ["abuseReport", "abuseReportResolved"] + } + }, + "url": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "secret": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "required": ["id", "isActive", "name", "on", "url", "secret"] } } } }, "responses": { - "204": { "description": "OK (without any results)" }, + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/SystemWebhook" + } + } + } + }, "400": { "description": "Client error", "content": { @@ -11496,16 +13201,16 @@ } } }, - "/admin/roles/users": { + "/announcements": { "post": { - "operationId": "admin/roles/users", - "summary": "admin/roles/users", - "description": "No description provided.\n\n**Credential required**: *No* / **Permission**: *read:admin:roles*", + "operationId": "announcements", + "summary": "announcements", + "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/users.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/announcements.ts" }, - "tags": ["admin"], + "tags": ["meta"], "requestBody": { "required": true, "content": { @@ -11513,17 +13218,16 @@ "schema": { "type": "object", "properties": { - "roleId": { "type": "string", "format": "misskey:id" }, - "sinceId": { "type": "string", "format": "misskey:id" }, - "untilId": { "type": "string", "format": "misskey:id" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10 - } - }, - "required": ["roleId"] + }, + "sinceId": { "type": "string", "format": "misskey:id" }, + "untilId": { "type": "string", "format": "misskey:id" }, + "isActive": { "type": "boolean", "default": true } + } } } } @@ -11537,16 +13241,7 @@ "type": "array", "items": { "type": "object", - "properties": { - "id": { "type": "string", "format": "misskey:id" }, - "createdAt": { "type": "string", "format": "date-time" }, - "user": { "$ref": "#/components/schemas/UserDetailed" }, - "expiresAt": { - "type": ["string", "null"], - "format": "date-time" - } - }, - "required": ["id", "createdAt", "user", "expiresAt"] + "$ref": "#/components/schemas/Announcement" } } } @@ -11558,15 +13253,6 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { - "NO_SUCH_ROLE": { - "value": { - "error": { - "message": "No such role.", - "code": "NO_SUCH_ROLE", - "id": "224eff5e-2488-4b18-b3e7-f50d94421648" - } - } - }, "INVALID_PARAM": { "value": { "error": { @@ -11659,14 +13345,14 @@ } } }, - "/announcements": { + "/announcements/show": { "post": { - "operationId": "announcements", - "summary": "announcements", + "operationId": "announcements___show", + "summary": "announcements/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/announcements.ts" + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/announcements/show.ts" }, "tags": ["meta"], "requestBody": { @@ -11676,16 +13362,9 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 10 - }, - "sinceId": { "type": "string", "format": "misskey:id" }, - "untilId": { "type": "string", "format": "misskey:id" }, - "isActive": { "type": "boolean", "default": true } - } + "announcementId": { "type": "string", "format": "misskey:id" } + }, + "required": ["announcementId"] } } } @@ -11696,11 +13375,8 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/components/schemas/Announcement" - } + "type": "object", + "$ref": "#/components/schemas/Announcement" } } } @@ -11711,6 +13387,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { + "NO_SUCH_ANNOUNCEMENT": { + "value": { + "error": { + "message": "No such announcement.", + "code": "NO_SUCH_ANNOUNCEMENT", + "id": "b57b5e1d-4f49-404a-9edb-46b00268f121" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -11805,7 +13490,7 @@ }, "/antennas/create": { "post": { - "operationId": "antennas/create", + "operationId": "antennas___create", "summary": "antennas/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -11845,9 +13530,9 @@ "users": { "type": "array", "items": { "type": "string" } }, "caseSensitive": { "type": "boolean" }, "localOnly": { "type": "boolean" }, + "excludeBots": { "type": "boolean" }, "withReplies": { "type": "boolean" }, - "withFile": { "type": "boolean" }, - "notify": { "type": "boolean" } + "withFile": { "type": "boolean" } }, "required": [ "name", @@ -11857,8 +13542,7 @@ "users", "caseSensitive", "withReplies", - "withFile", - "notify" + "withFile" ] } } @@ -11994,7 +13678,7 @@ }, "/antennas/delete": { "post": { - "operationId": "antennas/delete", + "operationId": "antennas___delete", "summary": "antennas/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -12128,7 +13812,7 @@ }, "/antennas/list": { "post": { - "operationId": "antennas/list", + "operationId": "antennas___list", "summary": "antennas/list", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -12252,7 +13936,7 @@ }, "/antennas/notes": { "post": { - "operationId": "antennas/notes", + "operationId": "antennas___notes", "summary": "antennas/notes", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -12409,7 +14093,7 @@ }, "/antennas/show": { "post": { - "operationId": "antennas/show", + "operationId": "antennas___show", "summary": "antennas/show", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -12553,7 +14237,7 @@ }, "/antennas/update": { "post": { - "operationId": "antennas/update", + "operationId": "antennas___update", "summary": "antennas/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -12594,22 +14278,11 @@ "users": { "type": "array", "items": { "type": "string" } }, "caseSensitive": { "type": "boolean" }, "localOnly": { "type": "boolean" }, + "excludeBots": { "type": "boolean" }, "withReplies": { "type": "boolean" }, - "withFile": { "type": "boolean" }, - "notify": { "type": "boolean" } + "withFile": { "type": "boolean" } }, - "required": [ - "antennaId", - "name", - "src", - "keywords", - "excludeKeywords", - "users", - "caseSensitive", - "withReplies", - "withFile", - "notify" - ] + "required": ["antennaId"] } } } @@ -12744,7 +14417,7 @@ }, "/ap/get": { "post": { - "operationId": "ap/get", + "operationId": "ap___get", "summary": "ap/get", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:federation*", "externalDocs": { @@ -12891,7 +14564,7 @@ }, "/ap/show": { "post": { - "operationId": "ap/show", + "operationId": "ap___show", "summary": "ap/show", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -13074,7 +14747,7 @@ }, "/app/create": { "post": { - "operationId": "app/create", + "operationId": "app___create", "summary": "app/create", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -13215,7 +14888,7 @@ }, "/app/show": { "post": { - "operationId": "app/show", + "operationId": "app___show", "summary": "app/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -13358,7 +15031,7 @@ }, "/auth/accept": { "post": { - "operationId": "auth/accept", + "operationId": "auth___accept", "summary": "auth/accept", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -13490,7 +15163,7 @@ }, "/auth/session/generate": { "post": { - "operationId": "auth/session/generate", + "operationId": "auth___session___generate", "summary": "auth/session/generate", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -13635,7 +15308,7 @@ }, "/auth/session/show": { "post": { - "operationId": "auth/session/show", + "operationId": "auth___session___show", "summary": "auth/session/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -13784,7 +15457,7 @@ }, "/auth/session/userkey": { "post": { - "operationId": "auth/session/userkey", + "operationId": "auth___session___userkey", "summary": "auth/session/userkey", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -13953,7 +15626,7 @@ }, "/blocking/create": { "post": { - "operationId": "blocking/create", + "operationId": "blocking___create", "summary": "blocking/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:blocks*", "externalDocs": { @@ -14134,7 +15807,7 @@ }, "/blocking/delete": { "post": { - "operationId": "blocking/delete", + "operationId": "blocking___delete", "summary": "blocking/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:blocks*", "externalDocs": { @@ -14315,7 +15988,7 @@ }, "/blocking/list": { "post": { - "operationId": "blocking/list", + "operationId": "blocking___list", "summary": "blocking/list", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:blocks*", "externalDocs": { @@ -14459,7 +16132,7 @@ }, "/channels/create": { "post": { - "operationId": "channels/create", + "operationId": "channels___create", "summary": "channels/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:channels*", "externalDocs": { @@ -14642,7 +16315,7 @@ }, "/channels/featured": { "post": { - "operationId": "channels/featured", + "operationId": "channels___featured", "summary": "channels/featured", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -14765,7 +16438,7 @@ }, "/channels/follow": { "post": { - "operationId": "channels/follow", + "operationId": "channels___follow", "summary": "channels/follow", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:channels*", "externalDocs": { @@ -14899,7 +16572,7 @@ }, "/channels/followed": { "post": { - "operationId": "channels/followed", + "operationId": "channels___followed", "summary": "channels/followed", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:channels*", "externalDocs": { @@ -15043,7 +16716,7 @@ }, "/channels/owned": { "post": { - "operationId": "channels/owned", + "operationId": "channels___owned", "summary": "channels/owned", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:channels*", "externalDocs": { @@ -15187,7 +16860,7 @@ }, "/channels/show": { "post": { - "operationId": "channels/show", + "operationId": "channels___show", "summary": "channels/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -15330,7 +17003,7 @@ }, "/channels/timeline": { "post": { - "operationId": "channels/timeline", + "operationId": "channels___timeline", "summary": "channels/timeline", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -15487,7 +17160,7 @@ }, "/channels/unfollow": { "post": { - "operationId": "channels/unfollow", + "operationId": "channels___unfollow", "summary": "channels/unfollow", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:channels*", "externalDocs": { @@ -15621,7 +17294,7 @@ }, "/channels/update": { "post": { - "operationId": "channels/update", + "operationId": "channels___update", "summary": "channels/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:channels*", "externalDocs": { @@ -15809,7 +17482,7 @@ }, "/channels/favorite": { "post": { - "operationId": "channels/favorite", + "operationId": "channels___favorite", "summary": "channels/favorite", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:channels*", "externalDocs": { @@ -15943,7 +17616,7 @@ }, "/channels/unfavorite": { "post": { - "operationId": "channels/unfavorite", + "operationId": "channels___unfavorite", "summary": "channels/unfavorite", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:channels*", "externalDocs": { @@ -16077,7 +17750,7 @@ }, "/channels/my-favorites": { "post": { - "operationId": "channels/my-favorites", + "operationId": "channels___my-favorites", "summary": "channels/my-favorites", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:channels*", "externalDocs": { @@ -16201,7 +17874,7 @@ }, "/channels/search": { "post": { - "operationId": "channels/search", + "operationId": "channels___search", "summary": "channels/search", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -16351,7 +18024,7 @@ }, "/charts/active-users": { "get": { - "operationId": "charts/active-users", + "operationId": "charts___active-users", "summary": "charts/active-users", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -16532,7 +18205,7 @@ } }, "post": { - "operationId": "charts/active-users", + "operationId": "charts___active-users", "summary": "charts/active-users", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -16715,7 +18388,7 @@ }, "/charts/ap-request": { "get": { - "operationId": "charts/ap-request", + "operationId": "charts___ap-request", "summary": "charts/ap-request", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -16872,7 +18545,7 @@ } }, "post": { - "operationId": "charts/ap-request", + "operationId": "charts___ap-request", "summary": "charts/ap-request", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -17031,7 +18704,7 @@ }, "/charts/drive": { "get": { - "operationId": "charts/drive", + "operationId": "charts___drive", "summary": "charts/drive", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -17216,7 +18889,7 @@ } }, "post": { - "operationId": "charts/drive", + "operationId": "charts___drive", "summary": "charts/drive", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -17403,7 +19076,7 @@ }, "/charts/federation": { "get": { - "operationId": "charts/federation", + "operationId": "charts___federation", "summary": "charts/federation", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -17579,7 +19252,7 @@ } }, "post": { - "operationId": "charts/federation", + "operationId": "charts___federation", "summary": "charts/federation", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -17757,7 +19430,7 @@ }, "/charts/instance": { "get": { - "operationId": "charts/instance", + "operationId": "charts___instance", "summary": "charts/instance", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -18050,7 +19723,7 @@ } }, "post": { - "operationId": "charts/instance", + "operationId": "charts___instance", "summary": "charts/instance", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -18345,7 +20018,7 @@ }, "/charts/notes": { "get": { - "operationId": "charts/notes", + "operationId": "charts___notes", "summary": "charts/notes", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -18566,7 +20239,7 @@ } }, "post": { - "operationId": "charts/notes", + "operationId": "charts___notes", "summary": "charts/notes", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -18789,7 +20462,7 @@ }, "/charts/user/drive": { "get": { - "operationId": "charts/user/drive", + "operationId": "charts___user___drive", "summary": "charts/user/drive", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -18962,7 +20635,7 @@ } }, "post": { - "operationId": "charts/user/drive", + "operationId": "charts___user___drive", "summary": "charts/user/drive", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -19137,7 +20810,7 @@ }, "/charts/user/following": { "get": { - "operationId": "charts/user/following", + "operationId": "charts___user___following", "summary": "charts/user/following", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -19363,7 +21036,7 @@ } }, "post": { - "operationId": "charts/user/following", + "operationId": "charts___user___following", "summary": "charts/user/following", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -19591,7 +21264,7 @@ }, "/charts/user/notes": { "get": { - "operationId": "charts/user/notes", + "operationId": "charts___user___notes", "summary": "charts/user/notes", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -19758,7 +21431,7 @@ } }, "post": { - "operationId": "charts/user/notes", + "operationId": "charts___user___notes", "summary": "charts/user/notes", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -19927,7 +21600,7 @@ }, "/charts/user/pv": { "get": { - "operationId": "charts/user/pv", + "operationId": "charts___user___pv", "summary": "charts/user/pv", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -20097,7 +21770,7 @@ } }, "post": { - "operationId": "charts/user/pv", + "operationId": "charts___user___pv", "summary": "charts/user/pv", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -20269,7 +21942,7 @@ }, "/charts/user/reactions": { "get": { - "operationId": "charts/user/reactions", + "operationId": "charts___user___reactions", "summary": "charts/user/reactions", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -20431,7 +22104,7 @@ } }, "post": { - "operationId": "charts/user/reactions", + "operationId": "charts___user___reactions", "summary": "charts/user/reactions", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -20595,7 +22268,7 @@ }, "/charts/users": { "get": { - "operationId": "charts/users", + "operationId": "charts___users", "summary": "charts/users", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -20772,7 +22445,7 @@ } }, "post": { - "operationId": "charts/users", + "operationId": "charts___users", "summary": "charts/users", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -20951,7 +22624,7 @@ }, "/clips/add-note": { "post": { - "operationId": "clips/add-note", + "operationId": "clips___add-note", "summary": "clips/add-note", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -21132,7 +22805,7 @@ }, "/clips/remove-note": { "post": { - "operationId": "clips/remove-note", + "operationId": "clips___remove-note", "summary": "clips/remove-note", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -21276,7 +22949,7 @@ }, "/clips/create": { "post": { - "operationId": "clips/create", + "operationId": "clips___create", "summary": "clips/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -21430,7 +23103,7 @@ }, "/clips/delete": { "post": { - "operationId": "clips/delete", + "operationId": "clips___delete", "summary": "clips/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -21564,7 +23237,7 @@ }, "/clips/list": { "post": { - "operationId": "clips/list", + "operationId": "clips___list", "summary": "clips/list", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -21688,7 +23361,7 @@ }, "/clips/notes": { "post": { - "operationId": "clips/notes", + "operationId": "clips___notes", "summary": "clips/notes", "description": "No description provided.\n\n**Credential required**: *No* / **Permission**: *read:account*", "externalDocs": { @@ -21842,7 +23515,7 @@ }, "/clips/show": { "post": { - "operationId": "clips/show", + "operationId": "clips___show", "summary": "clips/show", "description": "No description provided.\n\n**Credential required**: *No* / **Permission**: *read:account*", "externalDocs": { @@ -21985,7 +23658,7 @@ }, "/clips/update": { "post": { - "operationId": "clips/update", + "operationId": "clips___update", "summary": "clips/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -22140,7 +23813,7 @@ }, "/clips/favorite": { "post": { - "operationId": "clips/favorite", + "operationId": "clips___favorite", "summary": "clips/favorite", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:clip-favorite*", "externalDocs": { @@ -22283,7 +23956,7 @@ }, "/clips/unfavorite": { "post": { - "operationId": "clips/unfavorite", + "operationId": "clips___unfavorite", "summary": "clips/unfavorite", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:clip-favorite*", "externalDocs": { @@ -22426,7 +24099,7 @@ }, "/clips/my-favorites": { "post": { - "operationId": "clips/my-favorites", + "operationId": "clips___my-favorites", "summary": "clips/my-favorites", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:clip-favorite*", "externalDocs": { @@ -22675,7 +24348,7 @@ }, "/drive/files": { "post": { - "operationId": "drive/files", + "operationId": "drive___files", "summary": "drive/files", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -22840,7 +24513,7 @@ }, "/drive/files/attached-notes": { "post": { - "operationId": "drive/files/attached-notes", + "operationId": "drive___files___attached-notes", "summary": "drive/files/attached-notes", "description": "Find the notes to which the given file is attached.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -22995,7 +24668,7 @@ }, "/drive/files/check-existence": { "post": { - "operationId": "drive/files/check-existence", + "operationId": "drive___files___check-existence", "summary": "drive/files/check-existence", "description": "Check if a given file exists.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -23123,7 +24796,7 @@ }, "/drive/files/create": { "post": { - "operationId": "drive/files/create", + "operationId": "drive___files___create", "summary": "drive/files/create", "description": "Upload a new drive file.\n\n**Credential required**: *Yes* / **Permission**: *write:drive*", "externalDocs": { @@ -23321,7 +24994,7 @@ }, "/drive/files/delete": { "post": { - "operationId": "drive/files/delete", + "operationId": "drive___files___delete", "summary": "drive/files/delete", "description": "Delete an existing drive file.\n\n**Credential required**: *Yes* / **Permission**: *write:drive*", "externalDocs": { @@ -23464,7 +25137,7 @@ }, "/drive/files/find-by-hash": { "post": { - "operationId": "drive/files/find-by-hash", + "operationId": "drive___files___find-by-hash", "summary": "drive/files/find-by-hash", "description": "Search for a drive file by a hash of the contents.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -23600,7 +25273,7 @@ }, "/drive/files/find": { "post": { - "operationId": "drive/files/find", + "operationId": "drive___files___find", "summary": "drive/files/find", "description": "Search for a drive file by the given parameters.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -23743,7 +25416,7 @@ }, "/drive/files/show": { "post": { - "operationId": "drive/files/show", + "operationId": "drive___files___show", "summary": "drive/files/show", "description": "Show the properties of a drive file.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -23897,7 +25570,7 @@ }, "/drive/files/update": { "post": { - "operationId": "drive/files/update", + "operationId": "drive___files___update", "summary": "drive/files/update", "description": "Update the properties of a drive file.\n\n**Credential required**: *Yes* / **Permission**: *write:drive*", "externalDocs": { @@ -24084,7 +25757,7 @@ }, "/drive/files/upload-from-url": { "post": { - "operationId": "drive/files/upload-from-url", + "operationId": "drive___files___upload-from-url", "summary": "drive/files/upload-from-url", "description": "Request the server to download a new drive file from the specified URL.\n\n**Credential required**: *Yes* / **Permission**: *write:drive*", "externalDocs": { @@ -24241,7 +25914,7 @@ }, "/drive/folders": { "post": { - "operationId": "drive/folders", + "operationId": "drive___folders", "summary": "drive/folders", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -24390,7 +26063,7 @@ }, "/drive/folders/create": { "post": { - "operationId": "drive/folders/create", + "operationId": "drive___folders___create", "summary": "drive/folders/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:drive*", "externalDocs": { @@ -24560,7 +26233,7 @@ }, "/drive/folders/delete": { "post": { - "operationId": "drive/folders/delete", + "operationId": "drive___folders___delete", "summary": "drive/folders/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:drive*", "externalDocs": { @@ -24703,7 +26376,7 @@ }, "/drive/folders/find": { "post": { - "operationId": "drive/folders/find", + "operationId": "drive___folders___find", "summary": "drive/folders/find", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -24846,7 +26519,7 @@ }, "/drive/folders/show": { "post": { - "operationId": "drive/folders/show", + "operationId": "drive___folders___show", "summary": "drive/folders/show", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -24990,7 +26663,7 @@ }, "/drive/folders/update": { "post": { - "operationId": "drive/folders/update", + "operationId": "drive___folders___update", "summary": "drive/folders/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:drive*", "externalDocs": { @@ -25157,7 +26830,7 @@ }, "/drive/stream": { "post": { - "operationId": "drive/stream", + "operationId": "drive___stream", "summary": "drive/stream", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:drive*", "externalDocs": { @@ -25302,7 +26975,7 @@ }, "/email-address/available": { "post": { - "operationId": "email-address/available", + "operationId": "email-address___available", "summary": "email-address/available", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -25839,7 +27512,7 @@ }, "/federation/followers": { "post": { - "operationId": "federation/followers", + "operationId": "federation___followers", "summary": "federation/followers", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -25984,7 +27657,7 @@ }, "/federation/following": { "post": { - "operationId": "federation/following", + "operationId": "federation___following", "summary": "federation/following", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -26129,7 +27802,7 @@ }, "/federation/instances": { "get": { - "operationId": "federation/instances", + "operationId": "federation___instances", "summary": "federation/instances", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -26300,7 +27973,7 @@ } }, "post": { - "operationId": "federation/instances", + "operationId": "federation___instances", "summary": "federation/instances", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -26473,7 +28146,7 @@ }, "/federation/show-instance": { "post": { - "operationId": "federation/show-instance", + "operationId": "federation___show-instance", "summary": "federation/show-instance", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -26608,7 +28281,7 @@ }, "/federation/update-remote-user": { "post": { - "operationId": "federation/update-remote-user", + "operationId": "federation___update-remote-user", "summary": "federation/update-remote-user", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -26732,7 +28405,7 @@ }, "/federation/users": { "post": { - "operationId": "federation/users", + "operationId": "federation___users", "summary": "federation/users", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -26877,7 +28550,7 @@ }, "/federation/stats": { "get": { - "operationId": "federation/stats", + "operationId": "federation___stats", "summary": "federation/stats", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -27036,7 +28709,7 @@ } }, "post": { - "operationId": "federation/stats", + "operationId": "federation___stats", "summary": "federation/stats", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -27197,7 +28870,7 @@ }, "/following/create": { "post": { - "operationId": "following/create", + "operationId": "following___create", "summary": "following/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:following*", "externalDocs": { @@ -27397,7 +29070,7 @@ }, "/following/delete": { "post": { - "operationId": "following/delete", + "operationId": "following___delete", "summary": "following/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:following*", "externalDocs": { @@ -27578,7 +29251,7 @@ }, "/following/update": { "post": { - "operationId": "following/update", + "operationId": "following___update", "summary": "following/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:following*", "externalDocs": { @@ -27761,7 +29434,7 @@ }, "/following/update-all": { "post": { - "operationId": "following/update-all", + "operationId": "following___update-all", "summary": "following/update-all", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:following*", "externalDocs": { @@ -27905,7 +29578,7 @@ }, "/following/invalidate": { "post": { - "operationId": "following/invalidate", + "operationId": "following___invalidate", "summary": "following/invalidate", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:following*", "externalDocs": { @@ -28086,7 +29759,7 @@ }, "/following/requests/accept": { "post": { - "operationId": "following/requests/accept", + "operationId": "following___requests___accept", "summary": "following/requests/accept", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:following*", "externalDocs": { @@ -28229,7 +29902,7 @@ }, "/following/requests/cancel": { "post": { - "operationId": "following/requests/cancel", + "operationId": "following___requests___cancel", "summary": "following/requests/cancel", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:following*", "externalDocs": { @@ -28382,7 +30055,7 @@ }, "/following/requests/list": { "post": { - "operationId": "following/requests/list", + "operationId": "following___requests___list", "summary": "following/requests/list", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:following*", "externalDocs": { @@ -28537,7 +30210,7 @@ }, "/following/requests/reject": { "post": { - "operationId": "following/requests/reject", + "operationId": "following___requests___reject", "summary": "following/requests/reject", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:following*", "externalDocs": { @@ -28671,7 +30344,7 @@ }, "/gallery/featured": { "post": { - "operationId": "gallery/featured", + "operationId": "gallery___featured", "summary": "gallery/featured", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -28813,7 +30486,7 @@ }, "/gallery/popular": { "post": { - "operationId": "gallery/popular", + "operationId": "gallery___popular", "summary": "gallery/popular", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -28936,7 +30609,7 @@ }, "/gallery/posts": { "post": { - "operationId": "gallery/posts", + "operationId": "gallery___posts", "summary": "gallery/posts", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -29079,7 +30752,7 @@ }, "/gallery/posts/create": { "post": { - "operationId": "gallery/posts/create", + "operationId": "gallery___posts___create", "summary": "gallery/posts/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:gallery*", "externalDocs": { @@ -29242,7 +30915,7 @@ }, "/gallery/posts/delete": { "post": { - "operationId": "gallery/posts/delete", + "operationId": "gallery___posts___delete", "summary": "gallery/posts/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:gallery*", "externalDocs": { @@ -29376,7 +31049,7 @@ }, "/gallery/posts/like": { "post": { - "operationId": "gallery/posts/like", + "operationId": "gallery___posts___like", "summary": "gallery/posts/like", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:gallery-likes*", "externalDocs": { @@ -29528,7 +31201,7 @@ }, "/gallery/posts/show": { "post": { - "operationId": "gallery/posts/show", + "operationId": "gallery___posts___show", "summary": "gallery/posts/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -29671,7 +31344,7 @@ }, "/gallery/posts/unlike": { "post": { - "operationId": "gallery/posts/unlike", + "operationId": "gallery___posts___unlike", "summary": "gallery/posts/unlike", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:gallery-likes*", "externalDocs": { @@ -29814,7 +31487,7 @@ }, "/gallery/posts/update": { "post": { - "operationId": "gallery/posts/update", + "operationId": "gallery___posts___update", "summary": "gallery/posts/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:gallery*", "externalDocs": { @@ -30361,7 +32034,7 @@ }, "/hashtags/list": { "post": { - "operationId": "hashtags/list", + "operationId": "hashtags___list", "summary": "hashtags/list", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -30529,7 +32202,7 @@ }, "/hashtags/search": { "post": { - "operationId": "hashtags/search", + "operationId": "hashtags___search", "summary": "hashtags/search", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -30667,7 +32340,7 @@ }, "/hashtags/show": { "post": { - "operationId": "hashtags/show", + "operationId": "hashtags___show", "summary": "hashtags/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -30808,7 +32481,7 @@ }, "/hashtags/trend": { "get": { - "operationId": "hashtags/trend", + "operationId": "hashtags___trend", "summary": "hashtags/trend", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -30937,7 +32610,7 @@ } }, "post": { - "operationId": "hashtags/trend", + "operationId": "hashtags___trend", "summary": "hashtags/trend", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -31068,7 +32741,7 @@ }, "/hashtags/users": { "post": { - "operationId": "hashtags/users", + "operationId": "hashtags___users", "summary": "hashtags/users", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -31363,7 +33036,7 @@ }, "/i/2fa/done": { "post": { - "operationId": "i/2fa/done", + "operationId": "i___2fa___done", "summary": "i/2fa/done", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -31501,7 +33174,7 @@ }, "/i/2fa/key-done": { "post": { - "operationId": "i/2fa/key-done", + "operationId": "i___2fa___key-done", "summary": "i/2fa/key-done", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -31660,7 +33333,7 @@ }, "/i/2fa/password-less": { "post": { - "operationId": "i/2fa/password-less", + "operationId": "i___2fa___password-less", "summary": "i/2fa/password-less", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -31791,7 +33464,7 @@ }, "/i/2fa/register-key": { "post": { - "operationId": "i/2fa/register-key", + "operationId": "i___2fa___register-key", "summary": "i/2fa/register-key", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -32049,7 +33722,7 @@ }, "/i/2fa/register": { "post": { - "operationId": "i/2fa/register", + "operationId": "i___2fa___register", "summary": "i/2fa/register", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -32200,7 +33873,7 @@ }, "/i/2fa/update-key": { "post": { - "operationId": "i/2fa/update-key", + "operationId": "i___2fa___update-key", "summary": "i/2fa/update-key", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -32343,7 +34016,7 @@ }, "/i/2fa/remove-key": { "post": { - "operationId": "i/2fa/remove-key", + "operationId": "i___2fa___remove-key", "summary": "i/2fa/remove-key", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -32478,7 +34151,7 @@ }, "/i/2fa/unregister": { "post": { - "operationId": "i/2fa/unregister", + "operationId": "i___2fa___unregister", "summary": "i/2fa/unregister", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -32612,7 +34285,7 @@ }, "/i/apps": { "post": { - "operationId": "i/apps", + "operationId": "i___apps", "summary": "i/apps", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -32767,7 +34440,7 @@ }, "/i/authorized-apps": { "post": { - "operationId": "i/authorized-apps", + "operationId": "i___authorized-apps", "summary": "i/authorized-apps", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -32925,7 +34598,7 @@ }, "/i/claim-achievement": { "post": { - "operationId": "i/claim-achievement", + "operationId": "i___claim-achievement", "summary": "i/claim-achievement", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -33131,7 +34804,7 @@ }, "/i/change-password": { "post": { - "operationId": "i/change-password", + "operationId": "i___change-password", "summary": "i/change-password", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -33257,7 +34930,7 @@ }, "/i/delete-account": { "post": { - "operationId": "i/delete-account", + "operationId": "i___delete-account", "summary": "i/delete-account", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -33382,7 +35055,7 @@ }, "/i/export-blocking": { "post": { - "operationId": "i/export-blocking", + "operationId": "i___export-blocking", "summary": "i/export-blocking", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -33511,7 +35184,7 @@ }, "/i/export-following": { "post": { - "operationId": "i/export-following", + "operationId": "i___export-following", "summary": "i/export-following", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -33654,7 +35327,7 @@ }, "/i/export-mute": { "post": { - "operationId": "i/export-mute", + "operationId": "i___export-mute", "summary": "i/export-mute", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -33783,7 +35456,7 @@ }, "/i/export-notes": { "post": { - "operationId": "i/export-notes", + "operationId": "i___export-notes", "summary": "i/export-notes", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -33912,7 +35585,7 @@ }, "/i/export-clips": { "post": { - "operationId": "i/export-clips", + "operationId": "i___export-clips", "summary": "i/export-clips", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -34041,7 +35714,7 @@ }, "/i/export-favorites": { "post": { - "operationId": "i/export-favorites", + "operationId": "i___export-favorites", "summary": "i/export-favorites", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -34170,7 +35843,7 @@ }, "/i/export-user-lists": { "post": { - "operationId": "i/export-user-lists", + "operationId": "i___export-user-lists", "summary": "i/export-user-lists", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -34299,7 +35972,7 @@ }, "/i/export-antennas": { "post": { - "operationId": "i/export-antennas", + "operationId": "i___export-antennas", "summary": "i/export-antennas", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -34428,7 +36101,7 @@ }, "/i/favorites": { "post": { - "operationId": "i/favorites", + "operationId": "i___favorites", "summary": "i/favorites", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:favorites*", "externalDocs": { @@ -34572,7 +36245,7 @@ }, "/i/gallery/likes": { "post": { - "operationId": "i/gallery/likes", + "operationId": "i___gallery___likes", "summary": "i/gallery/likes", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:gallery-likes*", "externalDocs": { @@ -34723,7 +36396,7 @@ }, "/i/gallery/posts": { "post": { - "operationId": "i/gallery/posts", + "operationId": "i___gallery___posts", "summary": "i/gallery/posts", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:gallery*", "externalDocs": { @@ -34867,7 +36540,7 @@ }, "/i/import-blocking": { "post": { - "operationId": "i/import-blocking", + "operationId": "i___import-blocking", "summary": "i/import-blocking", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -35046,7 +36719,7 @@ }, "/i/import-following": { "post": { - "operationId": "i/import-following", + "operationId": "i___import-following", "summary": "i/import-following", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -35226,7 +36899,7 @@ }, "/i/import-muting": { "post": { - "operationId": "i/import-muting", + "operationId": "i___import-muting", "summary": "i/import-muting", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -35405,7 +37078,7 @@ }, "/i/import-user-lists": { "post": { - "operationId": "i/import-user-lists", + "operationId": "i___import-user-lists", "summary": "i/import-user-lists", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -35584,7 +37257,7 @@ }, "/i/import-antennas": { "post": { - "operationId": "i/import-antennas", + "operationId": "i___import-antennas", "summary": "i/import-antennas", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -35763,7 +37436,7 @@ }, "/i/notifications": { "post": { - "operationId": "i/notifications", + "operationId": "i___notifications", "summary": "i/notifications", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:notifications*", "externalDocs": { @@ -35975,7 +37648,7 @@ }, "/i/notifications-grouped": { "post": { - "operationId": "i/notifications-grouped", + "operationId": "i___notifications-grouped", "summary": "i/notifications-grouped", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:notifications*", "externalDocs": { @@ -36191,7 +37864,7 @@ }, "/i/page-likes": { "post": { - "operationId": "i/page-likes", + "operationId": "i___page-likes", "summary": "i/page-likes", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:page-likes*", "externalDocs": { @@ -36342,7 +38015,7 @@ }, "/i/pages": { "post": { - "operationId": "i/pages", + "operationId": "i___pages", "summary": "i/pages", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:pages*", "externalDocs": { @@ -36486,7 +38159,7 @@ }, "/i/pin": { "post": { - "operationId": "i/pin", + "operationId": "i___pin", "summary": "i/pin", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -36648,7 +38321,7 @@ }, "/i/read-all-unread-notes": { "post": { - "operationId": "i/read-all-unread-notes", + "operationId": "i___read-all-unread-notes", "summary": "i/read-all-unread-notes", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -36759,7 +38432,7 @@ }, "/i/read-announcement": { "post": { - "operationId": "i/read-announcement", + "operationId": "i___read-announcement", "summary": "i/read-announcement", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -36884,7 +38557,7 @@ }, "/i/regenerate-token": { "post": { - "operationId": "i/regenerate-token", + "operationId": "i___regenerate-token", "summary": "i/regenerate-token", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -37006,7 +38679,7 @@ }, "/i/registry/get-all": { "post": { - "operationId": "i/registry/get-all", + "operationId": "i___registry___get-all", "summary": "i/registry/get-all", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -37140,7 +38813,7 @@ }, "/i/registry/get-detail": { "post": { - "operationId": "i/registry/get-detail", + "operationId": "i___registry___get-detail", "summary": "i/registry/get-detail", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -37293,7 +38966,7 @@ }, "/i/registry/get": { "post": { - "operationId": "i/registry/get", + "operationId": "i___registry___get", "summary": "i/registry/get", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -37437,7 +39110,7 @@ }, "/i/registry/keys-with-type": { "post": { - "operationId": "i/registry/keys-with-type", + "operationId": "i___registry___keys-with-type", "summary": "i/registry/keys-with-type", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -37576,7 +39249,7 @@ }, "/i/registry/keys": { "post": { - "operationId": "i/registry/keys", + "operationId": "i___registry___keys", "summary": "i/registry/keys", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -37712,7 +39385,7 @@ }, "/i/registry/remove": { "post": { - "operationId": "i/registry/remove", + "operationId": "i___registry___remove", "summary": "i/registry/remove", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -37851,7 +39524,7 @@ }, "/i/registry/scopes-with-domain": { "post": { - "operationId": "i/registry/scopes-with-domain", + "operationId": "i___registry___scopes-with-domain", "summary": "i/registry/scopes-with-domain", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -37984,7 +39657,7 @@ }, "/i/registry/set": { "post": { - "operationId": "i/registry/set", + "operationId": "i___registry___set", "summary": "i/registry/set", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -38115,7 +39788,7 @@ }, "/i/revoke-token": { "post": { - "operationId": "i/revoke-token", + "operationId": "i___revoke-token", "summary": "i/revoke-token", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -38243,7 +39916,7 @@ }, "/i/signin-history": { "post": { - "operationId": "i/signin-history", + "operationId": "i___signin-history", "summary": "i/signin-history", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -38386,7 +40059,7 @@ }, "/i/unpin": { "post": { - "operationId": "i/unpin", + "operationId": "i___unpin", "summary": "i/unpin", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -38530,7 +40203,7 @@ }, "/i/update-email": { "post": { - "operationId": "i/update-email", + "operationId": "i___update-email", "summary": "i/update-email", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -38590,6 +40263,15 @@ } } }, + "EMAIL_REQUIRED": { + "value": { + "error": { + "message": "Email address is required.", + "code": "EMAIL_REQUIRED", + "id": "324c7a88-59f2-492f-903f-89134f93e47e" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -38703,7 +40385,7 @@ }, "/i/update": { "post": { - "operationId": "i/update", + "operationId": "i___update", "summary": "i/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -39773,7 +41455,7 @@ }, "/i/move": { "post": { - "operationId": "i/move", + "operationId": "i___move", "summary": "i/move", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -39965,7 +41647,7 @@ }, "/i/webhooks/create": { "post": { - "operationId": "i/webhooks/create", + "operationId": "i___webhooks___create", "summary": "i/webhooks/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -40178,7 +41860,7 @@ }, "/i/webhooks/list": { "post": { - "operationId": "i/webhooks/list", + "operationId": "i___webhooks___list", "summary": "i/webhooks/list", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -40341,7 +42023,7 @@ }, "/i/webhooks/show": { "post": { - "operationId": "i/webhooks/show", + "operationId": "i___webhooks___show", "summary": "i/webhooks/show", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -40524,7 +42206,7 @@ }, "/i/webhooks/update": { "post": { - "operationId": "i/webhooks/update", + "operationId": "i___webhooks___update", "summary": "i/webhooks/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -40690,7 +42372,7 @@ }, "/i/webhooks/delete": { "post": { - "operationId": "i/webhooks/delete", + "operationId": "i___webhooks___delete", "summary": "i/webhooks/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -40824,7 +42506,7 @@ }, "/invite/create": { "post": { - "operationId": "invite/create", + "operationId": "invite___create", "summary": "invite/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:invite-codes*", "externalDocs": { @@ -40954,7 +42636,7 @@ }, "/invite/delete": { "post": { - "operationId": "invite/delete", + "operationId": "invite___delete", "summary": "invite/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:invite-codes*", "externalDocs": { @@ -41106,7 +42788,7 @@ }, "/invite/list": { "post": { - "operationId": "invite/list", + "operationId": "invite___list", "summary": "invite/list", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:invite-codes*", "externalDocs": { @@ -41250,7 +42932,7 @@ }, "/invite/limit": { "post": { - "operationId": "invite/limit", + "operationId": "invite___limit", "summary": "invite/limit", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:invite-codes*", "externalDocs": { @@ -42034,7 +43716,7 @@ }, "/miauth/gen-token": { "post": { - "operationId": "miauth/gen-token", + "operationId": "miauth___gen-token", "summary": "miauth/gen-token", "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -42178,7 +43860,7 @@ }, "/mute/create": { "post": { - "operationId": "mute/create", + "operationId": "mute___create", "summary": "mute/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:mutes*", "externalDocs": { @@ -42353,7 +44035,7 @@ }, "/mute/delete": { "post": { - "operationId": "mute/delete", + "operationId": "mute___delete", "summary": "mute/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:mutes*", "externalDocs": { @@ -42505,7 +44187,7 @@ }, "/mute/list": { "post": { - "operationId": "mute/list", + "operationId": "mute___list", "summary": "mute/list", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:mutes*", "externalDocs": { @@ -42649,7 +44331,7 @@ }, "/renote-mute/create": { "post": { - "operationId": "renote-mute/create", + "operationId": "renote-mute___create", "summary": "renote-mute/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:mutes*", "externalDocs": { @@ -42820,7 +44502,7 @@ }, "/renote-mute/delete": { "post": { - "operationId": "renote-mute/delete", + "operationId": "renote-mute___delete", "summary": "renote-mute/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:mutes*", "externalDocs": { @@ -42972,7 +44654,7 @@ }, "/renote-mute/list": { "post": { - "operationId": "renote-mute/list", + "operationId": "renote-mute___list", "summary": "renote-mute/list", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:mutes*", "externalDocs": { @@ -43116,7 +44798,7 @@ }, "/my/apps": { "post": { - "operationId": "my/apps", + "operationId": "my___apps", "summary": "my/apps", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -43407,7 +45089,7 @@ }, "/notes/children": { "post": { - "operationId": "notes/children", + "operationId": "notes___children", "summary": "notes/children", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -43552,7 +45234,7 @@ }, "/notes/clips": { "post": { - "operationId": "notes/clips", + "operationId": "notes___clips", "summary": "notes/clips", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -43698,7 +45380,7 @@ }, "/notes/conversation": { "post": { - "operationId": "notes/conversation", + "operationId": "notes___conversation", "summary": "notes/conversation", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -43851,7 +45533,7 @@ }, "/notes/create": { "post": { - "operationId": "notes/create", + "operationId": "notes___create", "summary": "notes/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:notes*", "externalDocs": { @@ -44238,7 +45920,7 @@ }, "/notes/delete": { "post": { - "operationId": "notes/delete", + "operationId": "notes___delete", "summary": "notes/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:notes*", "externalDocs": { @@ -44400,7 +46082,7 @@ }, "/notes/favorites/create": { "post": { - "operationId": "notes/favorites/create", + "operationId": "notes___favorites___create", "summary": "notes/favorites/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:favorites*", "externalDocs": { @@ -44562,7 +46244,7 @@ }, "/notes/favorites/delete": { "post": { - "operationId": "notes/favorites/delete", + "operationId": "notes___favorites___delete", "summary": "notes/favorites/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:favorites*", "externalDocs": { @@ -44705,7 +46387,7 @@ }, "/notes/featured": { "get": { - "operationId": "notes/featured", + "operationId": "notes___featured", "summary": "notes/featured", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -44849,7 +46531,7 @@ } }, "post": { - "operationId": "notes/featured", + "operationId": "notes___featured", "summary": "notes/featured", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -44995,7 +46677,7 @@ }, "/notes/global-timeline": { "post": { - "operationId": "notes/global-timeline", + "operationId": "notes___global-timeline", "summary": "notes/global-timeline", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -45151,7 +46833,7 @@ }, "/notes/hybrid-timeline": { "post": { - "operationId": "notes/hybrid-timeline", + "operationId": "notes___hybrid-timeline", "summary": "notes/hybrid-timeline", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -45325,7 +47007,7 @@ }, "/notes/local-timeline": { "post": { - "operationId": "notes/local-timeline", + "operationId": "notes___local-timeline", "summary": "notes/local-timeline", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -45492,7 +47174,7 @@ }, "/notes/mentions": { "post": { - "operationId": "notes/mentions", + "operationId": "notes___mentions", "summary": "notes/mentions", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -45638,7 +47320,7 @@ }, "/notes/polls/recommendation": { "post": { - "operationId": "notes/polls/recommendation", + "operationId": "notes___polls___recommendation", "summary": "notes/polls/recommendation", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -45660,7 +47342,8 @@ "maximum": 100, "default": 10 }, - "offset": { "type": "integer", "default": 0 } + "offset": { "type": "integer", "default": 0 }, + "excludeChannels": { "type": "boolean", "default": false } } } } @@ -45781,7 +47464,7 @@ }, "/notes/polls/vote": { "post": { - "operationId": "notes/polls/vote", + "operationId": "notes___polls___vote", "summary": "notes/polls/vote", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:votes*", "externalDocs": { @@ -45961,7 +47644,7 @@ }, "/notes/reactions": { "get": { - "operationId": "notes/reactions", + "operationId": "notes___reactions", "summary": "notes/reactions", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -46114,7 +47797,7 @@ } }, "post": { - "operationId": "notes/reactions", + "operationId": "notes___reactions", "summary": "notes/reactions", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -46269,7 +47952,7 @@ }, "/notes/reactions/create": { "post": { - "operationId": "notes/reactions/create", + "operationId": "notes___reactions___create", "summary": "notes/reactions/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:reactions*", "externalDocs": { @@ -46422,7 +48105,7 @@ }, "/notes/reactions/delete": { "post": { - "operationId": "notes/reactions/delete", + "operationId": "notes___reactions___delete", "summary": "notes/reactions/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:reactions*", "externalDocs": { @@ -46584,7 +48267,7 @@ }, "/notes/renotes": { "post": { - "operationId": "notes/renotes", + "operationId": "notes___renotes", "summary": "notes/renotes", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -46738,7 +48421,7 @@ }, "/notes/replies": { "post": { - "operationId": "notes/replies", + "operationId": "notes___replies", "summary": "notes/replies", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -46883,7 +48566,7 @@ }, "/notes/search-by-tag": { "post": { - "operationId": "notes/search-by-tag", + "operationId": "notes___search-by-tag", "summary": "notes/search-by-tag", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -47046,7 +48729,7 @@ }, "/notes/search": { "post": { - "operationId": "notes/search", + "operationId": "notes___search", "summary": "notes/search", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -47215,7 +48898,7 @@ }, "/notes/show": { "post": { - "operationId": "notes/show", + "operationId": "notes___show", "summary": "notes/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -47358,7 +49041,7 @@ }, "/notes/state": { "post": { - "operationId": "notes/state", + "operationId": "notes___state", "summary": "notes/state", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -47497,7 +49180,7 @@ }, "/notes/thread-muting/create": { "post": { - "operationId": "notes/thread-muting/create", + "operationId": "notes___thread-muting___create", "summary": "notes/thread-muting/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -47650,7 +49333,7 @@ }, "/notes/thread-muting/delete": { "post": { - "operationId": "notes/thread-muting/delete", + "operationId": "notes___thread-muting___delete", "summary": "notes/thread-muting/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -47784,7 +49467,7 @@ }, "/notes/timeline": { "post": { - "operationId": "notes/timeline", + "operationId": "notes___timeline", "summary": "notes/timeline", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -47939,7 +49622,7 @@ }, "/notes/translate": { "post": { - "operationId": "notes/translate", + "operationId": "notes___translate", "summary": "notes/translate", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -47979,6 +49662,7 @@ } } }, + "204": { "description": "OK (without any results)" }, "400": { "description": "Client error", "content": { @@ -48003,6 +49687,15 @@ } } }, + "CANNOT_TRANSLATE_INVISIBLE_NOTE": { + "value": { + "error": { + "message": "Cannot translate invisible note.", + "code": "CANNOT_TRANSLATE_INVISIBLE_NOTE", + "id": "ea29f2ca-c368-43b3-aaf1-5ac3e74bbe5d" + } + } + }, "INVALID_PARAM": { "value": { "error": { @@ -48097,7 +49790,7 @@ }, "/notes/unrenote": { "post": { - "operationId": "notes/unrenote", + "operationId": "notes___unrenote", "summary": "notes/unrenote", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:notes*", "externalDocs": { @@ -48250,7 +49943,7 @@ }, "/notes/user-list-timeline": { "post": { - "operationId": "notes/user-list-timeline", + "operationId": "notes___user-list-timeline", "summary": "notes/user-list-timeline", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -48420,7 +50113,7 @@ }, "/notifications/create": { "post": { - "operationId": "notifications/create", + "operationId": "notifications___create", "summary": "notifications/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:notifications*", "externalDocs": { @@ -48566,7 +50259,7 @@ }, "/notifications/flush": { "post": { - "operationId": "notifications/flush", + "operationId": "notifications___flush", "summary": "notifications/flush", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:notifications*", "externalDocs": { @@ -48677,7 +50370,7 @@ }, "/notifications/mark-all-as-read": { "post": { - "operationId": "notifications/mark-all-as-read", + "operationId": "notifications___mark-all-as-read", "summary": "notifications/mark-all-as-read", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:notifications*", "externalDocs": { @@ -48788,7 +50481,7 @@ }, "/notifications/test-notification": { "post": { - "operationId": "notifications/test-notification", + "operationId": "notifications___test-notification", "summary": "notifications/test-notification", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:notifications*", "externalDocs": { @@ -49053,7 +50746,7 @@ }, "/pages/create": { "post": { - "operationId": "pages/create", + "operationId": "pages___create", "summary": "pages/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:pages*", "externalDocs": { @@ -49247,7 +50940,7 @@ }, "/pages/delete": { "post": { - "operationId": "pages/delete", + "operationId": "pages___delete", "summary": "pages/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:pages*", "externalDocs": { @@ -49390,7 +51083,7 @@ }, "/pages/featured": { "post": { - "operationId": "pages/featured", + "operationId": "pages___featured", "summary": "pages/featured", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -49513,7 +51206,7 @@ }, "/pages/like": { "post": { - "operationId": "pages/like", + "operationId": "pages___like", "summary": "pages/like", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:page-likes*", "externalDocs": { @@ -49665,7 +51358,7 @@ }, "/pages/show": { "post": { - "operationId": "pages/show", + "operationId": "pages___show", "summary": "pages/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -49813,7 +51506,7 @@ }, "/pages/unlike": { "post": { - "operationId": "pages/unlike", + "operationId": "pages___unlike", "summary": "pages/unlike", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:page-likes*", "externalDocs": { @@ -49956,7 +51649,7 @@ }, "/pages/update": { "post": { - "operationId": "pages/update", + "operationId": "pages___update", "summary": "pages/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:pages*", "externalDocs": { @@ -50162,7 +51855,7 @@ }, "/flash/create": { "post": { - "operationId": "flash/create", + "operationId": "flash___create", "summary": "flash/create", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:flash*", "externalDocs": { @@ -50184,6 +51877,11 @@ "permissions": { "type": "array", "items": { "type": "string" } + }, + "visibility": { + "type": "string", + "enum": ["public", "private"], + "default": "public" } }, "required": ["title", "summary", "script", "permissions"] @@ -50322,7 +52020,7 @@ }, "/flash/delete": { "post": { - "operationId": "flash/delete", + "operationId": "flash___delete", "summary": "flash/delete", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:flash*", "externalDocs": { @@ -50465,7 +52163,7 @@ }, "/flash/featured": { "post": { - "operationId": "flash/featured", + "operationId": "flash___featured", "summary": "flash/featured", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -50588,7 +52286,7 @@ }, "/flash/like": { "post": { - "operationId": "flash/like", + "operationId": "flash___like", "summary": "flash/like", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:flash-likes*", "externalDocs": { @@ -50740,7 +52438,7 @@ }, "/flash/show": { "post": { - "operationId": "flash/show", + "operationId": "flash___show", "summary": "flash/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -50883,7 +52581,7 @@ }, "/flash/unlike": { "post": { - "operationId": "flash/unlike", + "operationId": "flash___unlike", "summary": "flash/unlike", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:flash-likes*", "externalDocs": { @@ -51026,7 +52724,7 @@ }, "/flash/update": { "post": { - "operationId": "flash/update", + "operationId": "flash___update", "summary": "flash/update", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:flash*", "externalDocs": { @@ -51199,7 +52897,7 @@ }, "/flash/my": { "post": { - "operationId": "flash/my", + "operationId": "flash___my", "summary": "flash/my", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:flash*", "externalDocs": { @@ -51343,7 +53041,7 @@ }, "/flash/my-likes": { "post": { - "operationId": "flash/my-likes", + "operationId": "flash___my-likes", "summary": "flash/my-likes", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:flash-likes*", "externalDocs": { @@ -51738,7 +53436,7 @@ }, "/promo/read": { "post": { - "operationId": "promo/read", + "operationId": "promo___read", "summary": "promo/read", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -51872,7 +53570,7 @@ }, "/roles/list": { "post": { - "operationId": "roles/list", + "operationId": "roles___list", "summary": "roles/list", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -51996,7 +53694,7 @@ }, "/roles/show": { "post": { - "operationId": "roles/show", + "operationId": "roles___show", "summary": "roles/show", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -52139,7 +53837,7 @@ }, "/roles/users": { "post": { - "operationId": "roles/users", + "operationId": "roles___users", "summary": "roles/users", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -52300,7 +53998,7 @@ }, "/roles/notes": { "post": { - "operationId": "roles/notes", + "operationId": "roles___notes", "summary": "roles/notes", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -53259,7 +54957,7 @@ }, "/sw/show-registration": { "post": { - "operationId": "sw/show-registration", + "operationId": "sw___show-registration", "summary": "sw/show-registration", "description": "Check push notification registration exists.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -53398,7 +55096,7 @@ }, "/sw/update-registration": { "post": { - "operationId": "sw/update-registration", + "operationId": "sw___update-registration", "summary": "sw/update-registration", "description": "Update push notification registration.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -53548,7 +55246,7 @@ }, "/sw/register": { "post": { - "operationId": "sw/register", + "operationId": "sw___register", "summary": "sw/register", "description": "Register to receive push notifications.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes*", "externalDocs": { @@ -53696,7 +55394,7 @@ }, "/sw/unregister": { "post": { - "operationId": "sw/unregister", + "operationId": "sw___unregister", "summary": "sw/unregister", "description": "Unregister from receiving push notifications.\n\n**Credential required**: *No*", "externalDocs": { @@ -53969,7 +55667,7 @@ }, "/username/available": { "post": { - "operationId": "username/available", + "operationId": "username___available", "summary": "username/available", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -54272,7 +55970,7 @@ }, "/users/clips": { "post": { - "operationId": "users/clips", + "operationId": "users___clips", "summary": "users/clips", "description": "Show all clips this user owns.\n\n**Credential required**: *No*", "externalDocs": { @@ -54417,7 +56115,7 @@ }, "/users/followers": { "post": { - "operationId": "users/followers", + "operationId": "users___followers", "summary": "users/followers", "description": "Show everyone that follows this user.\n\n**Credential required**: *No*", "externalDocs": { @@ -54588,7 +56286,7 @@ }, "/users/following": { "post": { - "operationId": "users/following", + "operationId": "users___following", "summary": "users/following", "description": "Show everyone that this user is following.\n\n**Credential required**: *No*", "externalDocs": { @@ -54617,7 +56315,10 @@ "type": ["string", "null"], "description": "The local host is represented with `null`." }, - "birthday": { "type": ["string", "null"] } + "birthday": { + "type": ["string", "null"], + "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})$" + } }, "anyOf": [ { "required": ["userId"] }, @@ -54769,7 +56470,7 @@ }, "/users/gallery/posts": { "post": { - "operationId": "users/gallery/posts", + "operationId": "users___gallery___posts", "summary": "users/gallery/posts", "description": "Show all gallery posts by the given user.\n\n**Credential required**: *No*", "externalDocs": { @@ -54914,7 +56615,7 @@ }, "/users/get-frequently-replied-users": { "post": { - "operationId": "users/get-frequently-replied-users", + "operationId": "users___get-frequently-replied-users", "summary": "users/get-frequently-replied-users", "description": "Get a list of other users that the specified user frequently replies to.\n\n**Credential required**: *No*", "externalDocs": { @@ -55073,7 +56774,7 @@ }, "/users/featured-notes": { "get": { - "operationId": "users/featured-notes", + "operationId": "users___featured-notes", "summary": "users/featured-notes", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -55215,7 +56916,7 @@ } }, "post": { - "operationId": "users/featured-notes", + "operationId": "users___featured-notes", "summary": "users/featured-notes", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -55359,7 +57060,7 @@ }, "/users/lists/create": { "post": { - "operationId": "users/lists/create", + "operationId": "users___lists___create", "summary": "users/lists/create", "description": "Create a new list of users.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -55503,7 +57204,7 @@ }, "/users/lists/delete": { "post": { - "operationId": "users/lists/delete", + "operationId": "users___lists___delete", "summary": "users/lists/delete", "description": "Delete an existing list of users.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -55637,7 +57338,7 @@ }, "/users/lists/list": { "post": { - "operationId": "users/lists/list", + "operationId": "users___lists___list", "summary": "users/lists/list", "description": "Show all lists that the authenticated user has created.\n\n**Credential required**: *No* / **Permission**: *read:account*", "externalDocs": { @@ -55791,7 +57492,7 @@ }, "/users/lists/pull": { "post": { - "operationId": "users/lists/pull", + "operationId": "users___lists___pull", "summary": "users/lists/pull", "description": "Remove a user from a list.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -55935,7 +57636,7 @@ }, "/users/lists/push": { "post": { - "operationId": "users/lists/push", + "operationId": "users___lists___push", "summary": "users/lists/push", "description": "Add a user to an existing list.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -56125,7 +57826,7 @@ }, "/users/lists/show": { "post": { - "operationId": "users/lists/show", + "operationId": "users___lists___show", "summary": "users/lists/show", "description": "Show the properties of a list.\n\n**Credential required**: *No* / **Permission**: *read:account*", "externalDocs": { @@ -56269,7 +57970,7 @@ }, "/users/lists/favorite": { "post": { - "operationId": "users/lists/favorite", + "operationId": "users___lists___favorite", "summary": "users/lists/favorite", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -56411,7 +58112,7 @@ }, "/users/lists/unfavorite": { "post": { - "operationId": "users/lists/unfavorite", + "operationId": "users___lists___unfavorite", "summary": "users/lists/unfavorite", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -56553,7 +58254,7 @@ }, "/users/lists/update": { "post": { - "operationId": "users/lists/update", + "operationId": "users___lists___update", "summary": "users/lists/update", "description": "Update the properties of a list.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -56703,7 +58404,7 @@ }, "/users/lists/create-from-public": { "post": { - "operationId": "users/lists/create-from-public", + "operationId": "users___lists___create-from-public", "summary": "users/lists/create-from-public", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -56896,7 +58597,7 @@ }, "/users/lists/update-membership": { "post": { - "operationId": "users/lists/update-membership", + "operationId": "users___lists___update-membership", "summary": "users/lists/update-membership", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -57041,7 +58742,7 @@ }, "/users/lists/get-memberships": { "post": { - "operationId": "users/lists/get-memberships", + "operationId": "users___lists___get-memberships", "summary": "users/lists/get-memberships", "description": "No description provided.\n\n**Credential required**: *No* / **Permission**: *read:account*", "externalDocs": { @@ -57212,7 +58913,7 @@ }, "/users/notes": { "post": { - "operationId": "users/notes", + "operationId": "users___notes", "summary": "users/notes", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -57382,7 +59083,7 @@ }, "/users/pages": { "post": { - "operationId": "users/pages", + "operationId": "users___pages", "summary": "users/pages", "description": "Show all pages this user created.\n\n**Credential required**: *No*", "externalDocs": { @@ -57527,7 +59228,7 @@ }, "/users/flashs": { "post": { - "operationId": "users/flashs", + "operationId": "users___flashs", "summary": "users/flashs", "description": "Show all flashs this user created.\n\n**Credential required**: *No*", "externalDocs": { @@ -57672,7 +59373,7 @@ }, "/users/reactions": { "post": { - "operationId": "users/reactions", + "operationId": "users___reactions", "summary": "users/reactions", "description": "Show all reactions this user made.\n\n**Credential required**: *No*", "externalDocs": { @@ -57837,7 +59538,7 @@ }, "/users/recommendation": { "post": { - "operationId": "users/recommendation", + "operationId": "users___recommendation", "summary": "users/recommendation", "description": "Show users that the authenticated user might be interested to follow.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -57980,7 +59681,7 @@ }, "/users/relation": { "post": { - "operationId": "users/relation", + "operationId": "users___relation", "summary": "users/relation", "description": "Show the different kinds of relations between the authenticated user and the specified user(s).\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -58178,7 +59879,7 @@ }, "/users/report-abuse": { "post": { - "operationId": "users/report-abuse", + "operationId": "users___report-abuse", "summary": "users/report-abuse", "description": "File a report.\n\n**Credential required**: *Yes* / **Permission**: *write:report-abuse*", "externalDocs": { @@ -58335,7 +60036,7 @@ }, "/users/search-by-username-and-host": { "post": { - "operationId": "users/search-by-username-and-host", + "operationId": "users___search-by-username-and-host", "summary": "users/search-by-username-and-host", "description": "Search for a user by username and/or host.\n\n**Credential required**: *No*", "externalDocs": { @@ -58483,7 +60184,7 @@ }, "/users/search": { "post": { - "operationId": "users/search", + "operationId": "users___search", "summary": "users/search", "description": "Search for users.\n\n**Credential required**: *No*", "externalDocs": { @@ -58633,7 +60334,7 @@ }, "/users/show": { "post": { - "operationId": "users/show", + "operationId": "users___show", "summary": "users/show", "description": "Show the properties of a user.\n\n**Credential required**: *No*", "externalDocs": { @@ -58812,7 +60513,7 @@ }, "/users/achievements": { "post": { - "operationId": "users/achievements", + "operationId": "users___achievements", "summary": "users/achievements", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -58952,7 +60653,7 @@ }, "/users/update-memo": { "post": { - "operationId": "users/update-memo", + "operationId": "users___update-memo", "summary": "users/update-memo", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -59118,140 +60819,294 @@ "schema": { "type": "object", "properties": { - "items": { "type": "array", "items": { "type": "object" } } - }, - "required": ["items"] - } - } - } - }, - "400": { - "description": "Client error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "INVALID_PARAM": { - "value": { - "error": { - "message": "Invalid param.", - "code": "INVALID_PARAM", - "id": "3d81ceae-475f-4600-b2a8-2bc116157532" - } - } - } - } - } - } - }, - "401": { - "description": "Authentication error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "CREDENTIAL_REQUIRED": { - "value": { - "error": { - "message": "Credential required.", - "code": "CREDENTIAL_REQUIRED", - "id": "1384574d-a912-4b81-8601-c7b1c4085df1" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "AUTHENTICATION_FAILED": { - "value": { - "error": { - "message": "Authentication failed. Please ensure your token is correct.", - "code": "AUTHENTICATION_FAILED", - "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + "image": { + "type": "object", + "properties": { + "link": { "type": "string" }, + "url": { "type": "string" }, + "title": { "type": "string" } + }, + "required": ["url"] + }, + "paginationLinks": { + "type": "object", + "properties": { + "self": { "type": "string" }, + "first": { "type": "string" }, + "next": { "type": "string" }, + "last": { "type": "string" }, + "prev": { "type": "string" } + } + }, + "link": { "type": "string" }, + "title": { "type": "string" }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "link": { "type": "string" }, + "guid": { "type": "string" }, + "title": { "type": "string" }, + "pubDate": { "type": "string" }, + "creator": { "type": "string" }, + "summary": { "type": "string" }, + "content": { "type": "string" }, + "isoDate": { "type": "string" }, + "categories": { + "type": "array", + "items": { "type": "string" } + }, + "contentSnippet": { "type": "string" }, + "enclosure": { + "type": "object", + "properties": { + "url": { "type": "string" }, + "length": { "type": "number" }, + "type": { "type": "string" } + }, + "required": ["url"] + } + } + } + }, + "feedUrl": { "type": "string" }, + "description": { "type": "string" }, + "itunes": { + "type": "object", + "additionalProperties": true, + "properties": { + "image": { "type": "string" }, + "owner": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "email": { "type": "string" } + } + }, + "author": { "type": "string" }, + "summary": { "type": "string" }, + "explicit": { "type": "string" }, + "categories": { + "type": "array", + "items": { "type": "string" } + }, + "keywords": { + "type": "array", + "items": { "type": "string" } + } + } + } + }, + "required": ["items"] + } + } + } + }, + "400": { + "description": "Client error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INVALID_PARAM": { + "value": { + "error": { + "message": "Invalid param.", + "code": "INVALID_PARAM", + "id": "3d81ceae-475f-4600-b2a8-2bc116157532" + } + } + } + } + } + } + }, + "401": { + "description": "Authentication error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "CREDENTIAL_REQUIRED": { + "value": { + "error": { + "message": "Credential required.", + "code": "CREDENTIAL_REQUIRED", + "id": "1384574d-a912-4b81-8601-c7b1c4085df1" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "AUTHENTICATION_FAILED": { + "value": { + "error": { + "message": "Authentication failed. Please ensure your token is correct.", + "code": "AUTHENTICATION_FAILED", + "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14" + } + } + } + } + } + } + }, + "418": { + "description": "I'm Ai", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "I_AM_AI": { + "value": { + "error": { + "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", + "code": "I_AM_AI", + "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" }, + "examples": { + "INTERNAL_ERROR": { + "value": { + "error": { + "message": "Internal error occurred. Please contact us if the error persists.", + "code": "INTERNAL_ERROR", + "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + } + } + } + } + } + } + } + } + }, + "post": { + "operationId": "fetch-rss", + "summary": "fetch-rss", + "description": "No description provided.\n\n**Credential required**: *No*", + "externalDocs": { + "description": "Source code", + "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/fetch-rss.ts" + }, + "tags": ["meta"], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { "url": { "type": "string" } }, + "required": ["url"] + } + } + } + }, + "responses": { + "200": { + "description": "OK (with results)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "link": { "type": "string" }, + "url": { "type": "string" }, + "title": { "type": "string" } + }, + "required": ["url"] + }, + "paginationLinks": { + "type": "object", + "properties": { + "self": { "type": "string" }, + "first": { "type": "string" }, + "next": { "type": "string" }, + "last": { "type": "string" }, + "prev": { "type": "string" } } - } - } - } - } - } - }, - "418": { - "description": "I'm Ai", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "I_AM_AI": { - "value": { - "error": { - "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.", - "code": "I_AM_AI", - "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84" + }, + "link": { "type": "string" }, + "title": { "type": "string" }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "link": { "type": "string" }, + "guid": { "type": "string" }, + "title": { "type": "string" }, + "pubDate": { "type": "string" }, + "creator": { "type": "string" }, + "summary": { "type": "string" }, + "content": { "type": "string" }, + "isoDate": { "type": "string" }, + "categories": { + "type": "array", + "items": { "type": "string" } + }, + "contentSnippet": { "type": "string" }, + "enclosure": { + "type": "object", + "properties": { + "url": { "type": "string" }, + "length": { "type": "number" }, + "type": { "type": "string" } + }, + "required": ["url"] + } + } } - } - } - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Error" }, - "examples": { - "INTERNAL_ERROR": { - "value": { - "error": { - "message": "Internal error occurred. Please contact us if the error persists.", - "code": "INTERNAL_ERROR", - "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac" + }, + "feedUrl": { "type": "string" }, + "description": { "type": "string" }, + "itunes": { + "type": "object", + "additionalProperties": true, + "properties": { + "image": { "type": "string" }, + "owner": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "email": { "type": "string" } + } + }, + "author": { "type": "string" }, + "summary": { "type": "string" }, + "explicit": { "type": "string" }, + "categories": { + "type": "array", + "items": { "type": "string" } + }, + "keywords": { + "type": "array", + "items": { "type": "string" } + } } } - } - } - } - } - } - } - }, - "post": { - "operationId": "fetch-rss", - "summary": "fetch-rss", - "description": "No description provided.\n\n**Credential required**: *No*", - "externalDocs": { - "description": "Source code", - "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/fetch-rss.ts" - }, - "tags": ["meta"], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { "url": { "type": "string" } }, - "required": ["url"] - } - } - } - }, - "responses": { - "200": { - "description": "OK (with results)", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "items": { "type": "array", "items": { "type": "object" } } }, "required": ["items"] } @@ -59799,7 +61654,7 @@ }, "/bubble-game/register": { "post": { - "operationId": "bubble-game/register", + "operationId": "bubble-game___register", "summary": "bubble-game/register", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -59962,7 +61817,7 @@ }, "/bubble-game/ranking": { "get": { - "operationId": "bubble-game/ranking", + "operationId": "bubble-game___ranking", "summary": "bubble-game/ranking", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -60102,7 +61957,7 @@ } }, "post": { - "operationId": "bubble-game/ranking", + "operationId": "bubble-game___ranking", "summary": "bubble-game/ranking", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -60244,7 +62099,7 @@ }, "/reversi/cancel-match": { "post": { - "operationId": "reversi/cancel-match", + "operationId": "reversi___cancel-match", "summary": "reversi/cancel-match", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -60370,7 +62225,7 @@ }, "/reversi/games": { "post": { - "operationId": "reversi/games", + "operationId": "reversi___games", "summary": "reversi/games", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -60510,7 +62365,7 @@ }, "/reversi/match": { "post": { - "operationId": "reversi/match", + "operationId": "reversi___match", "summary": "reversi/match", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -60669,7 +62524,7 @@ }, "/reversi/invitations": { "post": { - "operationId": "reversi/invitations", + "operationId": "reversi___invitations", "summary": "reversi/invitations", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:account*", "externalDocs": { @@ -60789,7 +62644,7 @@ }, "/reversi/show-game": { "post": { - "operationId": "reversi/show-game", + "operationId": "reversi___show-game", "summary": "reversi/show-game", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -60931,7 +62786,7 @@ }, "/reversi/surrender": { "post": { - "operationId": "reversi/surrender", + "operationId": "reversi___surrender", "summary": "reversi/surrender", "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*", "externalDocs": { @@ -61082,7 +62937,7 @@ }, "/reversi/verify": { "post": { - "operationId": "reversi/verify", + "operationId": "reversi___verify", "summary": "reversi/verify", "description": "No description provided.\n\n**Credential required**: *No*", "externalDocs": { @@ -61286,7 +63141,7 @@ "offsetX": { "type": "number" }, "offsetY": { "type": "number" } }, - "required": ["id", "url"] + "required": ["id", "angle", "flipH", "url", "offsetX", "offsetY"] } }, "isBot": { "type": "boolean" }, @@ -61339,8 +63194,12 @@ "avatarUrl", "avatarBlurhash", "avatarDecorations", + "isBot", + "isCat", + "instance", "emojis", - "onlineStatus" + "onlineStatus", + "badgeRoles" ] }, "UserDetailedNotMeOnly": { @@ -61468,7 +63327,18 @@ "usePasswordLessLogin", "securityKeys", "roles", - "memo" + "memo", + "moderationNote", + "isFollowing", + "isFollowed", + "hasPendingFollowRequestFromYou", + "hasPendingFollowRequestToYou", + "isBlocking", + "isBlocked", + "isMuted", + "isRenoteMuted", + "notify", + "withReplies" ] }, "MeDetailedOnly": { @@ -61943,7 +63813,23 @@ } ] } - } + }, + "required": [ + "note", + "follow", + "mention", + "reply", + "renote", + "quote", + "reaction", + "pollEnded", + "receiveFollowRequest", + "followRequestAccepted", + "roleAssigned", + "achievementEarned", + "app", + "test" + ] }, "emailNotificationTypes": { "type": "array", @@ -62017,7 +63903,10 @@ "emailNotificationTypes", "achievements", "loggedInDays", - "policies" + "policies", + "email", + "emailVerified", + "securityKeysList" ] }, "UserDetailedNotMe": { @@ -62068,7 +63957,7 @@ }, "isPublic": { "type": "boolean" } }, - "required": ["id", "createdAt", "name", "isPublic"] + "required": ["id", "createdAt", "name", "userIds", "isPublic"] }, "Ad": { "type": "object", @@ -62130,7 +64019,8 @@ "display", "needConfirmationToRead", "silence", - "forYou" + "forYou", + "isRead" ] }, "App": { @@ -62143,7 +64033,14 @@ "secret": { "type": "string" }, "isAuthorized": { "type": "boolean" } }, - "required": ["id", "name", "callbackUrl", "permission"] + "required": [ + "id", + "name", + "callbackUrl", + "permission", + "secret", + "isAuthorized" + ] }, "Note": { "type": "object", @@ -62259,6 +64156,7 @@ "type": "object", "additionalProperties": { "anyOf": [{ "type": "number" }] } }, + "reactionCount": { "type": "number" }, "renoteCount": { "type": "number" }, "repliesCount": { "type": "number" }, "uri": { "type": "string" }, @@ -62273,15 +64171,38 @@ "required": [ "id", "createdAt", + "deletedAt", "text", + "cw", "userId", "user", + "replyId", + "renoteId", + "reply", + "renote", + "isHidden", "visibility", + "mentions", + "visibleUserIds", + "fileIds", + "files", + "tags", + "poll", + "emojis", + "channelId", + "channel", + "localOnly", "reactionAcceptance", "reactionEmojis", "reactions", + "reactionCount", "renoteCount", - "repliesCount" + "repliesCount", + "uri", + "url", + "reactionAndUserPairCache", + "clippedCount", + "myReaction" ] }, "NoteReaction": { @@ -62569,7 +64490,8 @@ "height": { "type": "number", "example": 720 }, "orientation": { "type": "number", "example": 8 }, "avgColor": { "type": "string", "example": "rgb(40,65,87)" } - } + }, + "required": ["width", "height", "orientation", "avgColor"] }, "url": { "type": "string", "format": "url" }, "thumbnailUrl": { "type": ["string", "null"], "format": "url" }, @@ -62607,7 +64529,9 @@ "thumbnailUrl", "comment", "folderId", - "userId" + "folder", + "userId", + "user" ] }, "DriveFolder": { @@ -62628,7 +64552,15 @@ "allOf": [{ "$ref": "#/components/schemas/DriveFolder" }] } }, - "required": ["id", "createdAt", "name", "parentId"] + "required": [ + "id", + "createdAt", + "name", + "parentId", + "foldersCount", + "filesCount", + "parent" + ] }, "Following": { "type": "object", @@ -62646,7 +64578,14 @@ "allOf": [{ "$ref": "#/components/schemas/UserDetailedNotMe" }] } }, - "required": ["id", "createdAt", "followeeId", "followerId"] + "required": [ + "id", + "createdAt", + "followeeId", + "followerId", + "followee", + "follower" + ] }, "Muting": { "type": "object", @@ -62794,7 +64733,8 @@ "eyeCatchingImageId", "eyeCatchingImage", "attachedFiles", - "likedCount" + "likedCount", + "isLiked" ] }, "PageBlock": { @@ -62881,7 +64821,10 @@ "usersCount", "notesCount", "isSensitive", - "allowRenoteToExternal" + "allowRenoteToExternal", + "isFollowing", + "isFavorited", + "pinnedNotes" ] }, "QueueCount": { @@ -62917,11 +64860,12 @@ "users": { "type": "array", "items": { "type": "string" } }, "caseSensitive": { "type": "boolean", "default": false }, "localOnly": { "type": "boolean", "default": false }, - "notify": { "type": "boolean" }, + "excludeBots": { "type": "boolean", "default": false }, "withReplies": { "type": "boolean", "default": false }, "withFile": { "type": "boolean" }, "isActive": { "type": "boolean" }, - "hasUnreadNote": { "type": "boolean", "default": false } + "hasUnreadNote": { "type": "boolean", "default": false }, + "notify": { "type": "boolean", "default": false } }, "required": [ "id", @@ -62934,11 +64878,12 @@ "users", "caseSensitive", "localOnly", - "notify", + "excludeBots", "withReplies", "withFile", "isActive", - "hasUnreadNote" + "hasUnreadNote", + "notify" ] }, "Clip": { @@ -62956,7 +64901,8 @@ "description": { "type": ["string", "null"] }, "isPublic": { "type": "boolean" }, "favoritedCount": { "type": "number" }, - "isFavorited": { "type": "boolean" } + "isFavorited": { "type": "boolean" }, + "notesCount": { "type": "integer" } }, "required": [ "id", @@ -62967,7 +64913,9 @@ "name", "description", "isPublic", - "favoritedCount" + "favoritedCount", + "isFavorited", + "notesCount" ] }, "FederationInstance": { @@ -62982,6 +64930,15 @@ "followersCount": { "type": "number" }, "isNotResponding": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, + "suspensionState": { + "type": "string", + "enum": [ + "none", + "manuallySuspended", + "goneSuspended", + "autoSuspendedForNotResponding" + ] + }, "isBlocked": { "type": "boolean" }, "softwareName": { "type": ["string", "null"], "example": "misskey" }, "softwareVersion": { "type": ["string", "null"] }, @@ -63014,6 +64971,7 @@ "followersCount", "isNotResponding", "isSuspended", + "suspensionState", "isBlocked", "softwareName", "softwareVersion", @@ -63027,7 +64985,8 @@ "faviconUrl", "themeColor", "infoUpdatedAt", - "latestRequestReceivedAt" + "latestRequestReceivedAt", + "moderationNote" ] }, "GalleryPost": { @@ -63064,8 +65023,12 @@ "user", "title", "description", + "fileIds", + "files", + "tags", "isSensitive", - "likedCount" + "likedCount", + "isLiked" ] }, "EmojiSimple": { @@ -63085,7 +65048,15 @@ "items": { "type": "string", "format": "id" } } }, - "required": ["aliases", "name", "category", "url"] + "required": [ + "aliases", + "name", + "category", + "url", + "localOnly", + "isSensitive", + "roleIdsThatCanBeUsedThisEmojiAsReaction" + ] }, "EmojiDetailed": { "type": "object", @@ -63146,7 +65117,8 @@ "title", "summary", "script", - "likedCount" + "likedCount", + "isLiked" ] }, "Signin": { @@ -63192,6 +65164,23 @@ }, "required": ["id", "type"] }, + "RoleCondFormulaValueUserSettingBooleanSchema": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { + "type": "string", + "enum": [ + "isSuspended", + "isLocked", + "isBot", + "isCat", + "isExplorable" + ] + } + }, + "required": ["id", "type"] + }, "RoleCondFormulaValueAssignedRole": { "type": "object", "properties": { @@ -63244,6 +65233,9 @@ { "$ref": "#/components/schemas/RoleCondFormulaValueIsLocalOrRemote" }, + { + "$ref": "#/components/schemas/RoleCondFormulaValueUserSettingBooleanSchema" + }, { "$ref": "#/components/schemas/RoleCondFormulaValueAssignedRole" }, { "$ref": "#/components/schemas/RoleCondFormulaValueCreated" }, { @@ -63592,15 +65584,21 @@ ] } }, + "trustedLinkUrlPatterns": { + "type": "array", + "items": { "type": "string" } + }, "notesPerOneAd": { "type": "number", "default": 0 }, "enableEmail": { "type": "boolean" }, "enableServiceWorker": { "type": "boolean" }, "translatorAvailable": { "type": "boolean" }, "mediaProxy": { "type": "string" }, + "enableUrlPreview": { "type": "boolean" }, "backgroundImageUrl": { "type": ["string", "null"] }, "impressumUrl": { "type": ["string", "null"] }, "logoImageUrl": { "type": ["string", "null"] }, "privacyPolicyUrl": { "type": ["string", "null"] }, + "inquiryUrl": { "type": ["string", "null"] }, "serverRules": { "type": "array", "items": { "type": "string" } }, "themeColor": { "type": ["string", "null"] }, "policies": { @@ -63643,15 +65641,18 @@ "iconUrl", "maxNoteTextLength", "ads", + "trustedLinkUrlPatterns", "notesPerOneAd", "enableEmail", "enableServiceWorker", "translatorAvailable", "mediaProxy", + "enableUrlPreview", "backgroundImageUrl", "impressumUrl", "logoImageUrl", "privacyPolicyUrl", + "inquiryUrl", "serverRules", "themeColor", "policies" @@ -63683,7 +65684,8 @@ "turnstile", "recaptcha", "objectStorage", - "serviceWorker" + "serviceWorker", + "miauth" ] }, "proxyAccountName": { "type": ["string", "null"] }, @@ -63692,6 +65694,7 @@ "cacheRemoteSensitiveFiles": { "type": "boolean" } }, "required": [ + "features", "proxyAccountName", "requireSetup", "cacheRemoteFiles", @@ -63704,6 +65707,68 @@ { "type": "object", "$ref": "#/components/schemas/MetaLite" }, { "type": "object", "$ref": "#/components/schemas/MetaDetailedOnly" } ] + }, + "SystemWebhook": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "isActive": { "type": "boolean" }, + "updatedAt": { "type": "string", "format": "date-time" }, + "latestSentAt": { "type": ["string", "null"], "format": "date-time" }, + "latestStatus": { "type": ["number", "null"] }, + "name": { "type": "string" }, + "on": { + "type": "array", + "items": { + "type": "string", + "enum": ["abuseReport", "abuseReportResolved"] + } + }, + "url": { "type": "string" }, + "secret": { "type": "string" } + }, + "required": [ + "id", + "isActive", + "updatedAt", + "latestSentAt", + "latestStatus", + "name", + "on", + "url", + "secret" + ] + }, + "AbuseReportNotificationRecipient": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "isActive": { "type": "boolean" }, + "updatedAt": { "type": "string", "format": "date-time" }, + "name": { "type": "string" }, + "method": { "type": "string", "enum": ["email", "webhook"] }, + "userId": { "type": "string" }, + "user": { + "type": "object", + "allOf": [{ "$ref": "#/components/schemas/UserLite" }] + }, + "systemWebhookId": { "type": "string" }, + "systemWebhook": { + "type": "object", + "allOf": [{ "$ref": "#/components/schemas/SystemWebhook" }] + } + }, + "required": [ + "id", + "isActive", + "updatedAt", + "name", + "method", + "userId", + "user", + "systemWebhookId", + "systemWebhook" + ] } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } diff --git a/mipac/models/lite/meta.py b/mipac/models/lite/meta.py index a9aab1b5..86d47cd7 100644 --- a/mipac/models/lite/meta.py +++ b/mipac/models/lite/meta.py @@ -267,6 +267,10 @@ def enable_service_worker(self) -> bool: def translator_available(self) -> bool: return self._raw_meta["translator_available"] + @property + def inquiry_url(self) -> str | None: + return self._raw_meta["inquiry_url"] + @property def server_rules(self) -> list[str]: return self._raw_meta["server_rules"] diff --git a/mipac/models/note.py b/mipac/models/note.py index e6f5e272..d054602f 100644 --- a/mipac/models/note.py +++ b/mipac/models/note.py @@ -544,8 +544,8 @@ def reaction_acceptance(self) -> IReactionAcceptance: return self.__raw_note["reaction_acceptance"] @property - def reaction_emoji(self) -> dict[str, str]: - return self.__raw_note["reaction_emoji"] + def reaction_emojis(self) -> dict[str, str]: + return self.__raw_note["reaction_emojis"] @property def reactions(self) -> dict[str, int]: @@ -558,6 +558,17 @@ def reactions(self) -> dict[str, int]: """ return self.__raw_note["reactions"] + @property + def reaction_count(self) -> int: + """Note reactionCount + + Returns + ------- + int + note reactionCount + """ + return self.__raw_note["reaction_count"] + @property def renote_count(self) -> int: """Note renoteCount diff --git a/mipac/types/meta.py b/mipac/types/meta.py index c5427ae2..fa7d9bd9 100644 --- a/mipac/types/meta.py +++ b/mipac/types/meta.py @@ -80,17 +80,22 @@ class IPartialMeta(TypedDict): enable_email: bool enable_service_worker: bool translator_available: bool + inquiry_url: str | None server_rules: list[str] policies: IPolicies media_proxy: str -class IMeta(IPartialMeta): +class IMetaDetailedOnly(TypedDict): features: IFeatures + proxy_account_name: str + require_setup: bool cache_remote_files: bool cache_remote_sensitive_files: bool - require_setup: bool - proxy_account_name: str + + +class IMeta(IPartialMeta, TypedDict): + ... class IAdminMeta(TypedDict): # IMetaに含まれる物が多くあるけど、ない場合もあるので別にする diff --git a/mipac/types/note.py b/mipac/types/note.py index 9088f5ca..511de319 100644 --- a/mipac/types/note.py +++ b/mipac/types/note.py @@ -86,8 +86,9 @@ class INote(TypedDict): channel: NotRequired[INoteChannel | None] local_only: bool reaction_acceptance: IReactionAcceptance - reaction_emoji: dict[str, str] + reaction_emojis: dict[str, str] reactions: dict[str, int] # リアクションの種類と数 + reaction_count: int renote_count: int replies_count: int uri: NotRequired[str]