i/read-all-unread-notes

POSTAPIの概要 実装を見る

No description provided.

Credential required: Yes / Permission: write:account

パラメータ

名前既定値

204 レスポンス リクエスト成功(内容なし)

なし

400 エラー クライアント側エラー

名前
なし

401 エラー 認証エラー

名前
なし

403 エラー 権限関連のエラー

名前
なし

418 エラー I'm Ai

名前
なし

500 エラー サーバー内部エラー

名前
なし
{
  "_path": "/api-docs/endpoints/i/read-all-unread-notes",
  "_dir": "i",
  "_draft": false,
  "_partial": false,
  "_locale": "",
  "data": {
    "post": {
      "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": {
        "description": "Source code",
        "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/read-all-unread-notes.ts"
      },
      "tags": [
        "account"
      ],
      "security": [
        {
          "ApiKeyAuth": []
        }
      ],
      "requestBody": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {},
              "required": []
            }
          }
        }
      },
      "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"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "title": "i/read-all-unread-notes",
  "_id": "content:api-docs:endpoints:i:read-all-unread-notes.json",
  "_type": "json",
  "_source": "content",
  "_file": "api-docs/endpoints/i/read-all-unread-notes.json",
  "_extension": "json"
}