Yandex Wiki Public API

https://yandex.ru/support/wiki/ru/api-ref/
Admin
Yandex Wiki Public API is a REST API that enables programmatic access to Yandex Wiki pages,...
Tokens:1,202
Snippets:10
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Example Yandex API Error Response

Source: https://yandex.ru/support/wiki/ru/api-ref/index

An example of a general error response from the Yandex API, illustrating a 'VALIDATION_ERROR'. This example shows how the 'debug_message' provides a human-readable explanation, 'error_code' identifies the type of error, and 'details' can contain nested information about the validation failure.

```json
{
    "debug_message": "Validation failed",
    "details": {
        "body": {
            "data": [
                {
                    "debug_message": "field required",
                    "error_code": "value_error.missing"
                }
            ]
        }
    },
    "error_code": "VALIDATION_ERROR"
}
```

--------------------------------

### Error Response Format

Source: https://yandex.ru/support/wiki/ru/api-ref/index

Describes the general structure of error messages returned by the API, including debug messages, details, and error codes. It also provides specific formats for validation errors.

```APIDOC
## Error Response Format

### Description
This section details the structure of error responses from the API. The primary identifier for an error is the `error_code`, with `debug_message` providing a textual description and `details` offering additional context when necessary.

### General Error Structure
```json
{
    "debug_message": "string",
    "details": {},
    "error_code": "string"
}
```

### Example General Error
```json
{
    "debug_message": "Validation failed",
    "details": {
        "body": {
            "data": [
                {
                    "debug_message": "field required",
                    "error_code": "value_error.missing"
                }
            ]
        }
    },
    "error_code": "VALIDATION_ERROR"
}
```

### Validation Error Structure
This specific structure is used when a validation error occurs, indicating the source and field of the validation failure.

```json
{
    "debug_message": "Validation failed",
    "details": {
        "<source>": {
            "<field>": [
                {
                    "debug_message": "<validation debug message>",
                    "error_code": "<validation error code>"
                }
            ]
        }
    },
    "error_code": "VALIDATION_ERROR"
}
```

- **`<source>`**: The data source where the validation error occurred (e.g., `body`, `query`).
- **`<field>`**: The name of the field that failed validation. The value is a list containing detailed error messages and codes.
```

--------------------------------

### Cookie Policy

Source: https://yandex.ru/support/wiki/ru/api-ref/index

Information regarding Yandex's use of cookies, categorizing them into technical, analytics/marketing, and other types, and explaining their purpose.

```APIDOC
## Cookie Policy

### Description
This section outlines Yandex's use of cookies to ensure the smooth operation of its sites and services. Cookies are categorized based on their functionality and necessity.

### Cookie Categories

- **Technical, always active**: These cookies are essential for core website functions such as authorization and navigation. They are used by default.

- **Analytics/marketing**: These cookies enhance the quality of Yandex services by remembering user preferences, anonymously analyzing website traffic, and displaying relevant advertisements.

- **Other cookies**: These non-essential cookies improve the user experience by restoring web page sessions, remembering preferred regions, saving personal preferences, and more.
```

--------------------------------

### General Yandex API Error Format

Source: https://yandex.ru/support/wiki/ru/api-ref/index

This JSON structure represents a general error response from the Yandex API. It includes a debug message for developers, a details object for additional context, and a specific error code for programmatic handling. The 'details' field can be an empty object or contain nested error information.

```json
{
    "debug_message": "",
    "details": {},
    "error_code": ""
}
```

--------------------------------

### Yandex API Validation Error Format

Source: https://yandex.ru/support/wiki/ru/api-ref/index

This JSON structure details the format for validation errors within the Yandex API. It specifies that 'details' will contain information about the source of the error ('body' or 'query') and the specific field that failed validation, along with its corresponding debug message and error code.

```json
{
    "debug_message": "Validation failed",
    "details": {
        "<source>": {
            "<field>": [
                {
                    "debug_message": "<validation debug message>",
                    "error_code": "<validation error code>"
                }
            ]
        }
    },
    "error_code": "VALIDATION_ERROR"
}
```
Tokens:
Raw