OpenAPI
Интерактивная спецификация OpenAPI для /api/v2.
Спецификация генерируется из PHP attributes (swagger-php) в репозитории dle_api: apidata/openapi.yaml.
cd upload/api && composer openapiСырой файл: openapi.yaml
Интерактивный playground рендерится ниже через Fumadocs OpenAPI (app/lib/openapi.ts).
Request Body
application/json
Параметры OAuth2 grant
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/oauth/token" \ -H "Content-Type: application/json" \ -d '{ "grant_type": "client_credentials", "client_id": "string", "client_secret": "string" }'{ "access_token": "string", "token_type": "Bearer", "expires_in": 0, "refresh_token": "string", "scope": "string"}Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/oauth/revoke" \ -H "Content-Type: application/json" \ -d '{ "token": "string" }'{ "revoked": true}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Query Parameters
200Response Body
application/json
curl -X GET "https://example.com/post/"[ { "id": 0, "autor": "string", "date": "string", "short_story": "string", "full_story": "string", "xfields": "string", "title": "string", "descr": "string", "keywords": "string", "category": "string", "alt_name": "string", "comm_num": 0, "allow_comm": 0, "allow_main": 0, "approve": 0, "fixed": 0, "allow_br": 0, "symbol": "string", "tags": "string", "metatitle": "string" }]Authorization
bearerAuth Access token из POST /oauth/token
In: header
Request Body
application/json
Новость + optional nested children
TypeScript Definitions
Use the request body type in TypeScript.
Схема таблицы post (DLE install.php).
Response Body
application/json
curl -X POST "https://example.com/post/" \ -H "Content-Type: application/json" \ -d '{}'{ "id": 0}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Response Body
application/json
curl -X GET "https://example.com/post/0"{ "id": 0, "autor": "string", "date": "string", "short_story": "string", "full_story": "string", "xfields": "string", "title": "string", "descr": "string", "keywords": "string", "category": "string", "alt_name": "string", "comm_num": 0, "allow_comm": 0, "allow_main": 0, "approve": 0, "fixed": 0, "allow_br": 0, "symbol": "string", "tags": "string", "metatitle": "string"}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Логическое имя таблицы SchemaRegistry
Query Parameters
200Колонка сортировки (из схемы)
"DESC"Value in
- "ASC"
- "DESC"
Response Body
application/json
curl -X GET "https://example.com/table/string/"{ "data": [ { "id": 0, "name": "string", "date": 0, "ip": "string", "action": 0, "extras": "string" } ], "count": 0, "table": "string"}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Логическое имя таблицы SchemaRegistry
Request Body
application/json
Колонки выбранной таблицы (+ optional nested children). Схема = oneOf TableRow.
TypeScript Definitions
Use the request body type in TypeScript.
Тело записи: выберите схему по логическому имени таблицы в path {name} (SchemaRegistry).
Схема таблицы admin_logs (DLE install.php).
Response Body
application/json
curl -X POST "https://example.com/table/string/" \ -H "Content-Type: application/json" \ -d '{}'{ "id": 0, "table": "string"}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Логическое имя таблицы SchemaRegistry
Значение первичного ключа
Response Body
application/json
curl -X GET "https://example.com/table/string/string"{ "data": { "id": 0, "name": "string", "date": 0, "ip": "string", "action": 0, "extras": "string" }, "table": "string"}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Логическое имя таблицы SchemaRegistry
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Тело записи: выберите схему по логическому имени таблицы в path {name} (SchemaRegistry).
Схема таблицы admin_logs (DLE install.php).
Response Body
application/json
curl -X PUT "https://example.com/table/string/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "table": "string", "updated": true}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Логическое имя таблицы SchemaRegistry
Response Body
application/json
curl -X DELETE "https://example.com/table/string/string"{ "id": "string", "table": "string", "deleted": true}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Схема таблицы users (DLE install.php).
Response Body
application/json
curl -X POST "https://example.com/user/" \ -H "Content-Type: application/json" \ -d '{}'{ "id": 0}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Схема таблицы usergroups (DLE install.php).
Response Body
application/json
curl -X POST "https://example.com/usergroup/" \ -H "Content-Type: application/json" \ -d '{}'{ "id": 0}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Схема таблицы plugins (DLE install.php).
Response Body
application/json
curl -X POST "https://example.com/plugin/" \ -H "Content-Type: application/json" \ -d '{}'{ "id": 0}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/upload/" \ -F file="string"{}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Response Body
application/json
curl -X GET "https://example.com/conversations/"[ { "id": 0, "subject": "string", "created_at": 0, "updated_at": 0, "sender_id": 0, "recipient_id": 0 }]Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Value in
- "post"
- "user"
Response Body
application/json
curl -X GET "https://example.com/xfields/post/"{}Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Value in
- "post"
- "user"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "https://example.com/xfields/post/" \ -H "Content-Type: application/json" \ -d '{}'Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Value in
- "post"
- "user"
Response Body
curl -X GET "https://example.com/xfields/post/string"Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Value in
- "post"
- "user"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X PUT "https://example.com/xfields/post/string" \ -H "Content-Type: application/json" \ -d '{}'Authorization
bearerAuth Access token из POST /oauth/token
In: header
Path Parameters
Value in
- "post"
- "user"
Response Body
curl -X DELETE "https://example.com/xfields/post/string"Authorization
bearerAuth Access token из POST /oauth/token
In: header
Response Body
application/json
curl -X GET "https://example.com/health/"{ "ok": true, "version": "200.1.0"}Схемы
Компоненты components.schemas из OpenAPI.
- AdminLogs
- AdminSections
- Banned
- Banners
- BannersLogs
- BannersRubrics
- Category
- CommentRatingLog
- Comments
- CommentsFiles
- Complaint
- ConversationReads
- ConversationUsers
- Conversations
- ConversationsMessages
- DownloadsLog
- Files
- Flood
- IgnoreList
- Images
- Links
- LoginLog
- Logs
- Lostdb
- MailLog
- Metatags
- NewsletterTemplateCategories
- NewsletterTemplateItems
- Notice
- Plugins
- PluginsFiles
- PluginsLogs
- Poll
- PollLog
- Post
- PostExtras
- PostExtrasCats
- PostLog
- PostPass
- PostXfieldField
- PostXfieldGroup
- PostXfieldsCatalog
- Question
- ReadLog
- Redirects
- Rss
- Rssinform
- Sendlog
- SocialLogin
- SpamLog
- Static
- StaticFiles
- Storage
- Subscribe
- TableRow
- Tags
- Twofactor
- UserXfieldField
- UserXfieldsCatalog
- Usergroups
- Users
- UsersDelete
- Views
- Vote
- VoteResult
- Xfsearch