Удалить документацию

DELETE

/api/documentation/{id}

🔐 Требуется разрешение: can_manage_documentation

Удаляет документацию с учетом прав доступа пользователя.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

OAuth 2.0

Client Credentials

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: /api/apps/oauth/token

Scopes:

can_manage_documentation-Manage documentation

Path Params

Header Params

Responses

🟢204No Content

Документация успешно удалена

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/api/documentation/' \
--header 'X-Session-Id;' \
--header 'Accept-Language;' \
--header 'Authorization: <api-key>'

Response Example

400 - Success

{
    "error": {
        "name": "validation.failed",
        "msg": "Validation failed",
        "data": {},
        "validator_error": [
            {
                "property": "email",
                "constraints": {
                    "isEmail": "email must be an email"
                }
            }
        ]
    }
}

Modified at 2026-04-19 06:23:17

Обновить документацию

Восстановить удалённую документацию