meta
POSTAPIの概要 実装を見る
No description provided.
Credential required: No
パラメータ
| 名前 | 型 | 既定値 | |
|---|---|---|---|
| detail | 真偽値 | true | |
200 レスポンス リクエスト成功（内容あり）
| 名前 | 型 | 例 | |
|---|---|---|---|
| maintainerName | 文字列 | - | |
| maintainerEmail | 文字列 | - | |
| version | 文字列 | - | |
| name | 文字列 | - | |
| shortName | 文字列 | - | |
| uri | 文字列 | https://misskey.example.com | |
| description | 文字列 | - | |
| langs | 配列（内容: 文字列） | - | |
| tosUrl | 文字列 | - | |
| repositoryUrl | 文字列 | - | |
| feedbackUrl | 文字列 | - | |
| defaultDarkTheme | 文字列 | - | |
| defaultLightTheme | 文字列 | - | |
| disableRegistration | 真偽値 | - | |
| cacheRemoteFiles | 真偽値 | - | |
| cacheRemoteSensitiveFiles | 真偽値 | - | |
| emailRequiredForSignup | 真偽値 | - | |
| enableHcaptcha | 真偽値 | - | |
| hcaptchaSiteKey | 文字列 | - | |
| enableRecaptcha | 真偽値 | - | |
| recaptchaSiteKey | 文字列 | - | |
| enableTurnstile | 真偽値 | - | |
| turnstileSiteKey | 文字列 | - | |
| swPublickey | 文字列 | - | |
| mascotImageUrl | 文字列 | - | |
| bannerUrl | 文字列 | - | |
| serverErrorImageUrl | 文字列 | - | |
| infoImageUrl | 文字列 | - | |
| notFoundImageUrl | 文字列 | - | |
| iconUrl | 文字列 | - | |
| maxNoteTextLength | 数字 | - | |
| ads | 配列（内容: オブジェクト） | - | |
| requireSetup | 真偽値 | false | |
| enableEmail | 真偽値 | - | |
| enableServiceWorker | 真偽値 | - | |
| translatorAvailable | 真偽値 | - | |
| proxyAccountName | 文字列 | - | |
| mediaProxy | 文字列 | - | |
| features | オブジェクト | - | |
400 エラー クライアント側エラー
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
401 エラー 認証エラー
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
403 エラー 権限関連のエラー
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
418 エラー I'm Ai
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
500 エラー サーバー内部エラー
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
{
"_path": "/api-docs/endpoints/meta",
"_dir": "endpoints",
"_draft": false,
"_partial": false,
"_locale": "",
"data": {
"post": {
"operationId": "meta",
"summary": "meta",
"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/meta.ts"
},
"tags": [
"meta"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "boolean",
"default": true
}
},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK (with results)",
"content": {
"application/json": {
"schema": {
"type": "object",
"optional": false,
"nullable": false,
"properties": {
"maintainerName": {
"type": "string",
"optional": false,
"nullable": true
},
"maintainerEmail": {
"type": "string",
"optional": false,
"nullable": true
},
"version": {
"type": "string",
"optional": false,
"nullable": false
},
"name": {
"type": "string",
"optional": false,
"nullable": false
},
"shortName": {
"type": "string",
"optional": false,
"nullable": true
},
"uri": {
"type": "string",
"optional": false,
"nullable": false,
"format": "url",
"example": "https://misskey.example.com"
},
"description": {
"type": "string",
"optional": false,
"nullable": true
},
"langs": {
"type": "array",
"optional": false,
"nullable": false,
"items": {
"type": "string",
"optional": false,
"nullable": false
}
},
"tosUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"repositoryUrl": {
"type": "string",
"optional": false,
"nullable": false,
"default": "https://github.com/misskey-dev/misskey"
},
"feedbackUrl": {
"type": "string",
"optional": false,
"nullable": false,
"default": "https://github.com/misskey-dev/misskey/issues/new"
},
"defaultDarkTheme": {
"type": "string",
"optional": false,
"nullable": true
},
"defaultLightTheme": {
"type": "string",
"optional": false,
"nullable": true
},
"disableRegistration": {
"type": "boolean",
"optional": false,
"nullable": false
},
"cacheRemoteFiles": {
"type": "boolean",
"optional": false,
"nullable": false
},
"cacheRemoteSensitiveFiles": {
"type": "boolean",
"optional": false,
"nullable": false
},
"emailRequiredForSignup": {
"type": "boolean",
"optional": false,
"nullable": false
},
"enableHcaptcha": {
"type": "boolean",
"optional": false,
"nullable": false
},
"hcaptchaSiteKey": {
"type": "string",
"optional": false,
"nullable": true
},
"enableRecaptcha": {
"type": "boolean",
"optional": false,
"nullable": false
},
"recaptchaSiteKey": {
"type": "string",
"optional": false,
"nullable": true
},
"enableTurnstile": {
"type": "boolean",
"optional": false,
"nullable": false
},
"turnstileSiteKey": {
"type": "string",
"optional": false,
"nullable": true
},
"swPublickey": {
"type": "string",
"optional": false,
"nullable": true
},
"mascotImageUrl": {
"type": "string",
"optional": false,
"nullable": false,
"default": "/assets/ai.png"
},
"bannerUrl": {
"type": "string",
"optional": false,
"nullable": false
},
"serverErrorImageUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"infoImageUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"notFoundImageUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"iconUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"maxNoteTextLength": {
"type": "number",
"optional": false,
"nullable": false
},
"ads": {
"type": "array",
"optional": false,
"nullable": false,
"items": {
"type": "object",
"optional": false,
"nullable": false,
"properties": {
"place": {
"type": "string",
"optional": false,
"nullable": false
},
"url": {
"type": "string",
"optional": false,
"nullable": false,
"format": "url"
},
"imageUrl": {
"type": "string",
"optional": false,
"nullable": false,
"format": "url"
}
},
"required": [
"place",
"url",
"imageUrl"
]
}
},
"requireSetup": {
"type": "boolean",
"optional": false,
"nullable": false,
"example": false
},
"enableEmail": {
"type": "boolean",
"optional": false,
"nullable": false
},
"enableServiceWorker": {
"type": "boolean",
"optional": false,
"nullable": false
},
"translatorAvailable": {
"type": "boolean",
"optional": false,
"nullable": false
},
"proxyAccountName": {
"type": "string",
"optional": false,
"nullable": true
},
"mediaProxy": {
"type": "string",
"optional": false,
"nullable": false
},
"features": {
"type": "object",
"optional": true,
"nullable": false,
"properties": {
"registration": {
"type": "boolean",
"optional": false,
"nullable": false
},
"localTimeLine": {
"type": "boolean",
"optional": false,
"nullable": false
},
"globalTimeLine": {
"type": "boolean",
"optional": false,
"nullable": false
},
"hcaptcha": {
"type": "boolean",
"optional": false,
"nullable": false
},
"recaptcha": {
"type": "boolean",
"optional": false,
"nullable": false
},
"objectStorage": {
"type": "boolean",
"optional": false,
"nullable": false
},
"serviceWorker": {
"type": "boolean",
"optional": false,
"nullable": false
},
"miauth": {
"type": "boolean",
"optional": true,
"nullable": false,
"default": true
}
},
"required": [
"registration",
"localTimeLine",
"globalTimeLine",
"hcaptcha",
"recaptcha",
"objectStorage",
"serviceWorker"
]
}
},
"required": [
"maintainerName",
"maintainerEmail",
"version",
"name",
"shortName",
"uri",
"description",
"langs",
"tosUrl",
"repositoryUrl",
"feedbackUrl",
"defaultDarkTheme",
"defaultLightTheme",
"disableRegistration",
"cacheRemoteFiles",
"cacheRemoteSensitiveFiles",
"emailRequiredForSignup",
"enableHcaptcha",
"hcaptchaSiteKey",
"enableRecaptcha",
"recaptchaSiteKey",
"enableTurnstile",
"turnstileSiteKey",
"swPublickey",
"mascotImageUrl",
"bannerUrl",
"serverErrorImageUrl",
"infoImageUrl",
"notFoundImageUrl",
"iconUrl",
"maxNoteTextLength",
"ads",
"requireSetup",
"enableEmail",
"enableServiceWorker",
"translatorAvailable",
"proxyAccountName",
"mediaProxy"
]
}
}
}
},
"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": "meta",
"_id": "content:api-docs:endpoints:meta.json",
"_type": "json",
"_source": "content",
"_file": "api-docs/endpoints/meta.json",
"_extension": "json"
}