- admin/abuse-user-reports
- admin/delete-account
- admin/delete-all-files-of-a-user
- admin/get-index-stats
- admin/get-table-stats
- admin/get-user-ips
- admin/meta
- admin/reset-password
- admin/resolve-abuse-user-report
- admin/send-email
- admin/server-info
- admin/show-moderation-logs
- admin/show-user
- admin/show-users
- admin/suspend-user
- admin/unsuspend-user
- admin/update-meta
- admin/update-user-note
- announcements
- drive
- emoji
- emojis
- endpoint
- endpoints
- fetch-rss
- get-online-users-count
- i
- meta
- notes
- ping
- pinned-users
- request-reset-password
- reset-db
- reset-password
- retention
- server-info
- stats
- test
- users
admin/announcements/create
POSTAPIの概要 実装を見る
No description provided.
Credential required: Yes
パラメータ
名前 | 型 | 既定値 | |
---|---|---|---|
必須 | title | 文字列 | - |
必須 | text | 文字列 | - |
任意必須 | imageUrl | 文字列 | - |
icon | 文字列 | info | |
display | 文字列 | normal | |
forExistingUsers | 真偽値 | false | |
needConfirmationToRead | 真偽値 | false | |
任意 | userId | 文字列 | - |
200 レスポンス リクエスト成功(内容あり)
名前 | 型 | 例 | |
---|---|---|---|
id | 文字列 | xxxxxxxxxx | |
createdAt | 文字列 | - | |
updatedAt | 文字列 | - | |
title | 文字列 | - | |
text | 文字列 | - | |
imageUrl | 文字列 | - |
400 エラー クライアント側エラー
名前 | 型 | 例 | |
---|---|---|---|
なし |
401 エラー 認証エラー
名前 | 型 | 例 | |
---|---|---|---|
なし |
403 エラー 権限関連のエラー
名前 | 型 | 例 | |
---|---|---|---|
なし |
418 エラー I'm Ai
名前 | 型 | 例 | |
---|---|---|---|
なし |
500 エラー サーバー内部エラー
名前 | 型 | 例 | |
---|---|---|---|
なし |
{
"_path": "/api-docs/endpoints/admin/announcements/create",
"_dir": "announcements",
"_draft": false,
"_partial": false,
"_locale": "",
"data": {
"post": {
"operationId": "admin/announcements/create",
"summary": "admin/announcements/create",
"description": "No description provided.\n\n**Credential required**: *Yes*",
"externalDocs": {
"description": "Source code",
"url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/create.ts"
},
"tags": [
"admin"
],
"security": [
{
"ApiKeyAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1
},
"text": {
"type": "string",
"minLength": 1
},
"imageUrl": {
"type": "string",
"nullable": true,
"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
},
"needConfirmationToRead": {
"type": "boolean",
"default": false
},
"userId": {
"type": "string",
"format": "misskey:id",
"nullable": true,
"default": null
}
},
"required": [
"title",
"text",
"imageUrl"
]
}
}
}
},
"responses": {
"200": {
"description": "OK (with results)",
"content": {
"application/json": {
"schema": {
"type": "object",
"optional": false,
"nullable": false,
"properties": {
"id": {
"type": "string",
"optional": false,
"nullable": false,
"format": "id",
"example": "xxxxxxxxxx"
},
"createdAt": {
"type": "string",
"optional": false,
"nullable": false,
"format": "date-time"
},
"updatedAt": {
"type": "string",
"optional": false,
"nullable": true,
"format": "date-time"
},
"title": {
"type": "string",
"optional": false,
"nullable": false
},
"text": {
"type": "string",
"optional": false,
"nullable": false
},
"imageUrl": {
"type": "string",
"optional": false,
"nullable": true
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"title",
"text",
"imageUrl"
]
}
}
}
},
"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": "admin/announcements/create",
"_id": "content:api-docs:endpoints:admin:announcements:create.json",
"_type": "json",
"_source": "content",
"_file": "api-docs/endpoints/admin/announcements/create.json",
"_extension": "json"
}