Программный интерфейс
/web_api/public/text_document/file
/web_api/public/text_document/file
Страница собрана из снимка JSON Schema в репозитории документации. Снимок обновляется отдельной командой из каталога основного приложения и при сборке сайта не переписывается.
Запрос
main-app://schemas/api_public_text_document/file.request.json
GET /web_api/public/text_document/file query
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
token | string | Нет | - |
share_token | string | Нет | - |
file_uuid | string | Нет | - |
password | string | Нет | - |
Другие поля верхнего уровня допустимы.
Ответ
main-app://schemas/api_public_text_document/file.response.json
GET /web_api/public/text_document/file is not JSON
Именованных полей в схеме нет.
Исходная схема
Файлы ниже скопированы из снимка без изменений. Фрагмент по $ref приведён отдельным блоком, схемы не сливаются.
Запрос: main-app://schemas/api_public_text_document/file.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_public_text_document/file.request.json",
"title": "GET /web_api/public/text_document/file query",
"type": "object",
"required": [],
"additionalProperties": true,
"properties": {
"token": {
"type": "string"
},
"share_token": {
"type": "string"
},
"file_uuid": {
"type": "string"
},
"password": {
"type": "string"
}
}
}Ответ: main-app://schemas/api_public_text_document/file.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_public_text_document/file.response.json",
"title": "GET /web_api/public/text_document/file is not JSON",
"description": "Raw file bytes. Headers Content-Type, Cache-Control, X-Robots-Tag. Not the api_code envelope.",
"type": "string"
}Страница не помогла?