POSTAPIの概要 実装を見る

No description provided.

Credential required: Yes / Permission: write:following

パラメータ

名前既定値
必須userId文字列-

200 レスポンス リクエスト成功(内容あり)

名前
UserLite

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

名前
なし

401 エラー 認証エラー

名前
なし

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

名前
なし

418 エラー I'm Ai

名前
なし

429 エラー レートリミット

名前
なし

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

名前
なし
{
  "_path": "/api-docs/endpoints/following/delete",
  "_dir": "following",
  "_draft": false,
  "_partial": false,
  "_locale": "",
  "data": {
    "post": {
      "operationId": "following/delete",
      "summary": "following/delete",
      "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:following*",
      "externalDocs": {
        "description": "Source code",
        "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/following/delete.ts"
      },
      "tags": [
        "following"
      ],
      "security": [
        {
          "ApiKeyAuth": []
        }
      ],
      "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",
                "optional": false,
                "nullable": false,
                "ref": "UserLite",
                "$ref": "#/components/schemas/UserLite"
              }
            }
          }
        },
        "400": {
          "description": "Client error",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Error"
              },
              "examples": {
                "NO_SUCH_USER": {
                  "value": {
                    "error": {
                      "message": "No such user.",
                      "code": "NO_SUCH_USER",
                      "id": "5b12c78d-2b28-4dca-99d2-f56139b42ff8"
                    }
                  }
                },
                "FOLLOWEE_IS_YOURSELF": {
                  "value": {
                    "error": {
                      "message": "Followee is yourself.",
                      "code": "FOLLOWEE_IS_YOURSELF",
                      "id": "d9e400b9-36b0-4808-b1d8-79e707f1296c"
                    }
                  }
                },
                "NOT_FOLLOWING": {
                  "value": {
                    "error": {
                      "message": "You are not following that user.",
                      "code": "NOT_FOLLOWING",
                      "id": "5dbf82f5-c92b-40b1-87d1-6c8c0741fd09"
                    }
                  }
                },
                "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"
                    }
                  }
                }
              }
            }
          }
        },
        "429": {
          "description": "To many requests",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Error"
              },
              "examples": {
                "RATE_LIMIT_EXCEEDED": {
                  "value": {
                    "error": {
                      "message": "Rate limit exceeded. Please try again later.",
                      "code": "RATE_LIMIT_EXCEEDED",
                      "id": "d5826d14-3982-4d2e-8011-b9e9f02499ef"
                    }
                  }
                }
              }
            }
          }
        },
        "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": "following/delete",
  "_id": "content:api-docs:endpoints:following:delete.json",
  "_type": "json",
  "_source": "content",
  "_file": "api-docs/endpoints/following/delete.json",
  "_extension": "json"
}