aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2022-07-15 15:30:14 +0200
committerChocobozzz <me@florianbigard.com>2022-07-18 11:37:18 +0200
commit42b40636991b97fe818007fab19091764fc5db73 (patch)
treedb431787c06ce898d22e91ff771f795219274fc6 /support/doc/api
parent654d4ede7fa4d0faa71e49bcfab6b65a686397b2 (diff)
downloadPeerTube-42b40636991b97fe818007fab19091764fc5db73.tar.gz
PeerTube-42b40636991b97fe818007fab19091764fc5db73.tar.zst
PeerTube-42b40636991b97fe818007fab19091764fc5db73.zip
Add ability for client to create server logs
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml88
1 files changed, 80 insertions, 8 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 93c545e36..9745f68e9 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -330,26 +330,21 @@ x-tagGroups:
330 - name: Search 330 - name: Search
331 tags: 331 tags:
332 - Search 332 - Search
333 - name: Custom pages
334 tags:
335 - Homepage
336 - name: Moderation 333 - name: Moderation
337 tags: 334 tags:
338 - Abuses 335 - Abuses
339 - Video Blocks 336 - Video Blocks
340 - Account Blocks 337 - Account Blocks
341 - Server Blocks 338 - Server Blocks
342 - name: Instance Configuration 339 - name: Instance
343 tags: 340 tags:
344 - Config 341 - Config
342 - Homepage
345 - Instance Follows 343 - Instance Follows
346 - Instance Redundancy 344 - Instance Redundancy
347 - Plugins 345 - Plugins
348 - name: Stats
349 tags:
350 - Stats 346 - Stats
351 - name: Jobs 347 - Logs
352 tags:
353 - Job 348 - Job
354paths: 349paths:
355 '/accounts/{name}': 350 '/accounts/{name}':
@@ -4316,6 +4311,58 @@ paths:
4316 schema: 4311 schema:
4317 $ref: '#/components/schemas/ServerStats' 4312 $ref: '#/components/schemas/ServerStats'
4318 4313
4314 /server/logs/client:
4315 post:
4316 tags:
4317 - Logs
4318 summary: Send client log
4319 operationId: sendClientLog
4320 requestBody:
4321 content:
4322 application/json:
4323 schema:
4324 $ref: '#/components/schemas/SendClientLog'
4325 responses:
4326 '204':
4327 description: successful operation
4328
4329 /server/logs:
4330 get:
4331 tags:
4332 - Logs
4333 summary: Get instance logs
4334 operationId: getInstanceLogs
4335 security:
4336 - OAuth2:
4337 - admin
4338 responses:
4339 '200':
4340 description: successful operation
4341 content:
4342 application/json:
4343 schema:
4344 type: array
4345 items:
4346 type: string
4347
4348 /server/audit-logs:
4349 get:
4350 tags:
4351 - Logs
4352 summary: Get instance audit logs
4353 operationId: getInstanceAuditLogs
4354 security:
4355 - OAuth2:
4356 - admin
4357 responses:
4358 '200':
4359 description: successful operation
4360 content:
4361 application/json:
4362 schema:
4363 type: array
4364 items:
4365 type: string
4319 4366
4320 '/feeds/video-comments.{format}': 4367 '/feeds/video-comments.{format}':
4321 get: 4368 get:
@@ -6526,6 +6573,31 @@ components:
6526 enabled: 6573 enabled:
6527 type: boolean 6574 type: boolean
6528 6575
6576 SendClientLog:
6577 properties:
6578 message:
6579 type: string
6580 url:
6581 type: string
6582 description: URL of the current user page
6583 level:
6584 enum:
6585 - error
6586 - warn
6587 stackTrace:
6588 type: string
6589 description: Stack trace of the error if there is one
6590 userAgent:
6591 type: string
6592 description: User agent of the web browser that sends the message
6593 meta:
6594 type: string
6595 description: Additional information regarding this log
6596 required:
6597 - message
6598 - url
6599 - level
6600
6529 ServerStats: 6601 ServerStats:
6530 properties: 6602 properties:
6531 totalUsers: 6603 totalUsers: