@djangocfg/api 1.2.8 → 1.2.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8046,845 +8046,6 @@ export const OPENAPI_SCHEMA = {
8046
8046
  "x-async-capable": false
8047
8047
  }
8048
8048
  },
8049
- "/cfg/centrifugo/admin/api/monitor/channels/": {
8050
- "get": {
8051
- "description": "Get statistics per channel.",
8052
- "operationId": "cfg_centrifugo_admin_api_monitor_channels_retrieve",
8053
- "responses": {
8054
- "200": {
8055
- "description": "No response body"
8056
- }
8057
- },
8058
- "security": [
8059
- {
8060
- "jwtAuth": []
8061
- }
8062
- ],
8063
- "tags": [
8064
- "centrifugo"
8065
- ],
8066
- "x-async-capable": false
8067
- }
8068
- },
8069
- "/cfg/centrifugo/admin/api/monitor/health/": {
8070
- "get": {
8071
- "description": "Returns the current health status of the Centrifugo client.",
8072
- "operationId": "cfg_centrifugo_admin_api_monitor_health_retrieve",
8073
- "responses": {
8074
- "200": {
8075
- "content": {
8076
- "application/json": {
8077
- "schema": {
8078
- "$ref": "#/components/schemas/HealthCheck"
8079
- }
8080
- }
8081
- },
8082
- "description": ""
8083
- },
8084
- "503": {
8085
- "content": {
8086
- "application/json": {
8087
- "schema": {
8088
- "description": "Service unavailable"
8089
- }
8090
- }
8091
- },
8092
- "description": ""
8093
- }
8094
- },
8095
- "security": [
8096
- {
8097
- "jwtAuth": []
8098
- }
8099
- ],
8100
- "summary": "Get Centrifugo health status",
8101
- "tags": [
8102
- "Centrifugo Monitoring"
8103
- ],
8104
- "x-async-capable": false
8105
- }
8106
- },
8107
- "/cfg/centrifugo/admin/api/monitor/overview/": {
8108
- "get": {
8109
- "description": "Returns overview statistics for Centrifugo publishes.",
8110
- "operationId": "cfg_centrifugo_admin_api_monitor_overview_retrieve",
8111
- "parameters": [
8112
- {
8113
- "description": "Statistics period in hours (default: 24)",
8114
- "in": "query",
8115
- "name": "hours",
8116
- "schema": {
8117
- "type": "integer"
8118
- }
8119
- }
8120
- ],
8121
- "responses": {
8122
- "200": {
8123
- "content": {
8124
- "application/json": {
8125
- "schema": {
8126
- "$ref": "#/components/schemas/OverviewStats"
8127
- }
8128
- }
8129
- },
8130
- "description": ""
8131
- },
8132
- "400": {
8133
- "content": {
8134
- "application/json": {
8135
- "schema": {
8136
- "description": "Invalid parameters"
8137
- }
8138
- }
8139
- },
8140
- "description": ""
8141
- }
8142
- },
8143
- "security": [
8144
- {
8145
- "jwtAuth": []
8146
- }
8147
- ],
8148
- "summary": "Get overview statistics",
8149
- "tags": [
8150
- "Centrifugo Monitoring"
8151
- ],
8152
- "x-async-capable": false
8153
- }
8154
- },
8155
- "/cfg/centrifugo/admin/api/monitor/publishes/": {
8156
- "get": {
8157
- "description": "Returns a list of recent Centrifugo publishes with their details.",
8158
- "operationId": "cfg_centrifugo_admin_api_monitor_publishes_retrieve",
8159
- "parameters": [
8160
- {
8161
- "description": "Filter by channel name",
8162
- "in": "query",
8163
- "name": "channel",
8164
- "schema": {
8165
- "type": "string"
8166
- }
8167
- },
8168
- {
8169
- "description": "Number of publishes to return (default: 50, max: 200)",
8170
- "in": "query",
8171
- "name": "count",
8172
- "schema": {
8173
- "type": "integer"
8174
- }
8175
- },
8176
- {
8177
- "description": "Offset for pagination (default: 0)",
8178
- "in": "query",
8179
- "name": "offset",
8180
- "schema": {
8181
- "type": "integer"
8182
- }
8183
- },
8184
- {
8185
- "description": "Filter by status (success, failed, timeout, pending, partial)",
8186
- "in": "query",
8187
- "name": "status",
8188
- "schema": {
8189
- "type": "string"
8190
- }
8191
- }
8192
- ],
8193
- "responses": {
8194
- "200": {
8195
- "content": {
8196
- "application/json": {
8197
- "schema": {
8198
- "$ref": "#/components/schemas/RecentPublishes"
8199
- }
8200
- }
8201
- },
8202
- "description": ""
8203
- },
8204
- "400": {
8205
- "content": {
8206
- "application/json": {
8207
- "schema": {
8208
- "description": "Invalid parameters"
8209
- }
8210
- }
8211
- },
8212
- "description": ""
8213
- }
8214
- },
8215
- "security": [
8216
- {
8217
- "jwtAuth": []
8218
- }
8219
- ],
8220
- "summary": "Get recent publishes",
8221
- "tags": [
8222
- "Centrifugo Monitoring"
8223
- ],
8224
- "x-async-capable": false
8225
- }
8226
- },
8227
- "/cfg/centrifugo/admin/api/monitor/timeline/": {
8228
- "get": {
8229
- "description": "Returns statistics grouped by channel.",
8230
- "operationId": "cfg_centrifugo_admin_api_monitor_timeline_retrieve",
8231
- "parameters": [
8232
- {
8233
- "description": "Statistics period in hours (default: 24)",
8234
- "in": "query",
8235
- "name": "hours",
8236
- "schema": {
8237
- "type": "integer"
8238
- }
8239
- },
8240
- {
8241
- "description": "Time interval: \u0027hour\u0027 or \u0027day\u0027 (default: hour)",
8242
- "in": "query",
8243
- "name": "interval",
8244
- "schema": {
8245
- "type": "string"
8246
- }
8247
- }
8248
- ],
8249
- "responses": {
8250
- "200": {
8251
- "content": {
8252
- "application/json": {
8253
- "schema": {
8254
- "$ref": "#/components/schemas/ChannelList"
8255
- }
8256
- }
8257
- },
8258
- "description": ""
8259
- },
8260
- "400": {
8261
- "content": {
8262
- "application/json": {
8263
- "schema": {
8264
- "description": "Invalid parameters"
8265
- }
8266
- }
8267
- },
8268
- "description": ""
8269
- }
8270
- },
8271
- "security": [
8272
- {
8273
- "jwtAuth": []
8274
- }
8275
- ],
8276
- "summary": "Get channel statistics",
8277
- "tags": [
8278
- "Centrifugo Monitoring"
8279
- ],
8280
- "x-async-capable": false
8281
- }
8282
- },
8283
- "/cfg/centrifugo/admin/api/server/auth/token/": {
8284
- "post": {
8285
- "description": "Returns JWT token and config for WebSocket connection to Centrifugo.",
8286
- "operationId": "cfg_centrifugo_admin_api_server_auth_token_create",
8287
- "responses": {
8288
- "200": {
8289
- "content": {
8290
- "application/json": {
8291
- "schema": {
8292
- "properties": {
8293
- "config": {
8294
- "properties": {
8295
- "centrifugo_url": {
8296
- "type": "string"
8297
- },
8298
- "expires_at": {
8299
- "type": "string"
8300
- }
8301
- },
8302
- "type": "object"
8303
- },
8304
- "token": {
8305
- "type": "string"
8306
- }
8307
- },
8308
- "type": "object"
8309
- }
8310
- }
8311
- },
8312
- "description": ""
8313
- },
8314
- "400": {
8315
- "content": {
8316
- "application/json": {
8317
- "schema": {
8318
- "description": "Centrifugo not configured"
8319
- }
8320
- }
8321
- },
8322
- "description": ""
8323
- },
8324
- "500": {
8325
- "content": {
8326
- "application/json": {
8327
- "schema": {
8328
- "description": "Server error"
8329
- }
8330
- }
8331
- },
8332
- "description": ""
8333
- }
8334
- },
8335
- "security": [
8336
- {
8337
- "jwtAuth": []
8338
- }
8339
- ],
8340
- "summary": "Get connection token for dashboard",
8341
- "tags": [
8342
- "Centrifugo Admin API"
8343
- ],
8344
- "x-async-capable": false
8345
- }
8346
- },
8347
- "/cfg/centrifugo/admin/api/server/channels/": {
8348
- "post": {
8349
- "description": "Returns list of active channels with optional pattern filter.",
8350
- "operationId": "cfg_centrifugo_admin_api_server_channels_create",
8351
- "requestBody": {
8352
- "content": {
8353
- "application/json": {
8354
- "schema": {
8355
- "$ref": "#/components/schemas/CentrifugoChannelsRequestRequest"
8356
- }
8357
- },
8358
- "application/x-www-form-urlencoded": {
8359
- "schema": {
8360
- "$ref": "#/components/schemas/CentrifugoChannelsRequestRequest"
8361
- }
8362
- },
8363
- "multipart/form-data": {
8364
- "schema": {
8365
- "$ref": "#/components/schemas/CentrifugoChannelsRequestRequest"
8366
- }
8367
- }
8368
- }
8369
- },
8370
- "responses": {
8371
- "200": {
8372
- "content": {
8373
- "application/json": {
8374
- "schema": {
8375
- "$ref": "#/components/schemas/CentrifugoChannelsResponse"
8376
- }
8377
- }
8378
- },
8379
- "description": ""
8380
- },
8381
- "500": {
8382
- "content": {
8383
- "application/json": {
8384
- "schema": {
8385
- "description": "Server error"
8386
- }
8387
- }
8388
- },
8389
- "description": ""
8390
- }
8391
- },
8392
- "security": [
8393
- {
8394
- "jwtAuth": []
8395
- }
8396
- ],
8397
- "summary": "List active channels",
8398
- "tags": [
8399
- "Centrifugo Admin API"
8400
- ],
8401
- "x-async-capable": false
8402
- }
8403
- },
8404
- "/cfg/centrifugo/admin/api/server/history/": {
8405
- "post": {
8406
- "description": "Returns message history for a channel.",
8407
- "operationId": "cfg_centrifugo_admin_api_server_history_create",
8408
- "requestBody": {
8409
- "content": {
8410
- "application/json": {
8411
- "schema": {
8412
- "$ref": "#/components/schemas/CentrifugoHistoryRequestRequest"
8413
- }
8414
- },
8415
- "application/x-www-form-urlencoded": {
8416
- "schema": {
8417
- "$ref": "#/components/schemas/CentrifugoHistoryRequestRequest"
8418
- }
8419
- },
8420
- "multipart/form-data": {
8421
- "schema": {
8422
- "$ref": "#/components/schemas/CentrifugoHistoryRequestRequest"
8423
- }
8424
- }
8425
- },
8426
- "required": true
8427
- },
8428
- "responses": {
8429
- "200": {
8430
- "content": {
8431
- "application/json": {
8432
- "schema": {
8433
- "$ref": "#/components/schemas/CentrifugoHistoryResponse"
8434
- }
8435
- }
8436
- },
8437
- "description": ""
8438
- },
8439
- "500": {
8440
- "content": {
8441
- "application/json": {
8442
- "schema": {
8443
- "description": "Server error"
8444
- }
8445
- }
8446
- },
8447
- "description": ""
8448
- }
8449
- },
8450
- "security": [
8451
- {
8452
- "jwtAuth": []
8453
- }
8454
- ],
8455
- "summary": "Get channel history",
8456
- "tags": [
8457
- "Centrifugo Admin API"
8458
- ],
8459
- "x-async-capable": false
8460
- }
8461
- },
8462
- "/cfg/centrifugo/admin/api/server/info/": {
8463
- "post": {
8464
- "description": "Returns server information including node count, version, and uptime.",
8465
- "operationId": "cfg_centrifugo_admin_api_server_info_create",
8466
- "responses": {
8467
- "200": {
8468
- "content": {
8469
- "application/json": {
8470
- "schema": {
8471
- "$ref": "#/components/schemas/CentrifugoInfoResponse"
8472
- }
8473
- }
8474
- },
8475
- "description": ""
8476
- },
8477
- "500": {
8478
- "content": {
8479
- "application/json": {
8480
- "schema": {
8481
- "description": "Server error"
8482
- }
8483
- }
8484
- },
8485
- "description": ""
8486
- }
8487
- },
8488
- "security": [
8489
- {
8490
- "jwtAuth": []
8491
- }
8492
- ],
8493
- "summary": "Get Centrifugo server info",
8494
- "tags": [
8495
- "Centrifugo Admin API"
8496
- ],
8497
- "x-async-capable": false
8498
- }
8499
- },
8500
- "/cfg/centrifugo/admin/api/server/presence-stats/": {
8501
- "post": {
8502
- "description": "Returns quick statistics about channel presence (num_clients, num_users).",
8503
- "operationId": "cfg_centrifugo_admin_api_server_presence_stats_create",
8504
- "requestBody": {
8505
- "content": {
8506
- "application/json": {
8507
- "schema": {
8508
- "$ref": "#/components/schemas/CentrifugoPresenceStatsRequestRequest"
8509
- }
8510
- },
8511
- "application/x-www-form-urlencoded": {
8512
- "schema": {
8513
- "$ref": "#/components/schemas/CentrifugoPresenceStatsRequestRequest"
8514
- }
8515
- },
8516
- "multipart/form-data": {
8517
- "schema": {
8518
- "$ref": "#/components/schemas/CentrifugoPresenceStatsRequestRequest"
8519
- }
8520
- }
8521
- },
8522
- "required": true
8523
- },
8524
- "responses": {
8525
- "200": {
8526
- "content": {
8527
- "application/json": {
8528
- "schema": {
8529
- "$ref": "#/components/schemas/CentrifugoPresenceStatsResponse"
8530
- }
8531
- }
8532
- },
8533
- "description": ""
8534
- },
8535
- "500": {
8536
- "content": {
8537
- "application/json": {
8538
- "schema": {
8539
- "description": "Server error"
8540
- }
8541
- }
8542
- },
8543
- "description": ""
8544
- }
8545
- },
8546
- "security": [
8547
- {
8548
- "jwtAuth": []
8549
- }
8550
- ],
8551
- "summary": "Get channel presence statistics",
8552
- "tags": [
8553
- "Centrifugo Admin API"
8554
- ],
8555
- "x-async-capable": false
8556
- }
8557
- },
8558
- "/cfg/centrifugo/admin/api/server/presence/": {
8559
- "post": {
8560
- "description": "Returns list of clients currently subscribed to a channel.",
8561
- "operationId": "cfg_centrifugo_admin_api_server_presence_create",
8562
- "requestBody": {
8563
- "content": {
8564
- "application/json": {
8565
- "schema": {
8566
- "$ref": "#/components/schemas/CentrifugoPresenceRequestRequest"
8567
- }
8568
- },
8569
- "application/x-www-form-urlencoded": {
8570
- "schema": {
8571
- "$ref": "#/components/schemas/CentrifugoPresenceRequestRequest"
8572
- }
8573
- },
8574
- "multipart/form-data": {
8575
- "schema": {
8576
- "$ref": "#/components/schemas/CentrifugoPresenceRequestRequest"
8577
- }
8578
- }
8579
- },
8580
- "required": true
8581
- },
8582
- "responses": {
8583
- "200": {
8584
- "content": {
8585
- "application/json": {
8586
- "schema": {
8587
- "$ref": "#/components/schemas/CentrifugoPresenceResponse"
8588
- }
8589
- }
8590
- },
8591
- "description": ""
8592
- },
8593
- "500": {
8594
- "content": {
8595
- "application/json": {
8596
- "schema": {
8597
- "description": "Server error"
8598
- }
8599
- }
8600
- },
8601
- "description": ""
8602
- }
8603
- },
8604
- "security": [
8605
- {
8606
- "jwtAuth": []
8607
- }
8608
- ],
8609
- "summary": "Get channel presence",
8610
- "tags": [
8611
- "Centrifugo Admin API"
8612
- ],
8613
- "x-async-capable": false
8614
- }
8615
- },
8616
- "/cfg/centrifugo/admin/api/testing/connection-token/": {
8617
- "post": {
8618
- "description": "Generate JWT token for WebSocket connection to Centrifugo.",
8619
- "operationId": "cfg_centrifugo_admin_api_testing_connection_token_create",
8620
- "requestBody": {
8621
- "content": {
8622
- "application/json": {
8623
- "schema": {
8624
- "$ref": "#/components/schemas/ConnectionTokenRequestRequest"
8625
- }
8626
- },
8627
- "application/x-www-form-urlencoded": {
8628
- "schema": {
8629
- "$ref": "#/components/schemas/ConnectionTokenRequestRequest"
8630
- }
8631
- },
8632
- "multipart/form-data": {
8633
- "schema": {
8634
- "$ref": "#/components/schemas/ConnectionTokenRequestRequest"
8635
- }
8636
- }
8637
- },
8638
- "required": true
8639
- },
8640
- "responses": {
8641
- "200": {
8642
- "content": {
8643
- "application/json": {
8644
- "schema": {
8645
- "$ref": "#/components/schemas/ConnectionTokenResponse"
8646
- }
8647
- }
8648
- },
8649
- "description": ""
8650
- },
8651
- "400": {
8652
- "content": {
8653
- "application/json": {
8654
- "schema": {
8655
- "description": "Invalid request"
8656
- }
8657
- }
8658
- },
8659
- "description": ""
8660
- },
8661
- "500": {
8662
- "content": {
8663
- "application/json": {
8664
- "schema": {
8665
- "description": "Server error"
8666
- }
8667
- }
8668
- },
8669
- "description": ""
8670
- }
8671
- },
8672
- "security": [
8673
- {
8674
- "jwtAuth": []
8675
- }
8676
- ],
8677
- "summary": "Generate connection token",
8678
- "tags": [
8679
- "Centrifugo Testing"
8680
- ],
8681
- "x-async-capable": false
8682
- }
8683
- },
8684
- "/cfg/centrifugo/admin/api/testing/publish-test/": {
8685
- "post": {
8686
- "description": "Publish test message to Centrifugo via wrapper with optional ACK tracking.",
8687
- "operationId": "cfg_centrifugo_admin_api_testing_publish_test_create",
8688
- "requestBody": {
8689
- "content": {
8690
- "application/json": {
8691
- "schema": {
8692
- "$ref": "#/components/schemas/PublishTestRequestRequest"
8693
- }
8694
- },
8695
- "application/x-www-form-urlencoded": {
8696
- "schema": {
8697
- "$ref": "#/components/schemas/PublishTestRequestRequest"
8698
- }
8699
- },
8700
- "multipart/form-data": {
8701
- "schema": {
8702
- "$ref": "#/components/schemas/PublishTestRequestRequest"
8703
- }
8704
- }
8705
- },
8706
- "required": true
8707
- },
8708
- "responses": {
8709
- "200": {
8710
- "content": {
8711
- "application/json": {
8712
- "schema": {
8713
- "$ref": "#/components/schemas/PublishTestResponse"
8714
- }
8715
- }
8716
- },
8717
- "description": ""
8718
- },
8719
- "400": {
8720
- "content": {
8721
- "application/json": {
8722
- "schema": {
8723
- "description": "Invalid request"
8724
- }
8725
- }
8726
- },
8727
- "description": ""
8728
- },
8729
- "500": {
8730
- "content": {
8731
- "application/json": {
8732
- "schema": {
8733
- "description": "Server error"
8734
- }
8735
- }
8736
- },
8737
- "description": ""
8738
- }
8739
- },
8740
- "security": [
8741
- {
8742
- "jwtAuth": []
8743
- }
8744
- ],
8745
- "summary": "Publish test message",
8746
- "tags": [
8747
- "Centrifugo Testing"
8748
- ],
8749
- "x-async-capable": false
8750
- }
8751
- },
8752
- "/cfg/centrifugo/admin/api/testing/publish-with-logging/": {
8753
- "post": {
8754
- "description": "Publish message using CentrifugoClient with database logging. This will create CentrifugoLog records.",
8755
- "operationId": "cfg_centrifugo_admin_api_testing_publish_with_logging_create",
8756
- "requestBody": {
8757
- "content": {
8758
- "application/json": {
8759
- "schema": {
8760
- "$ref": "#/components/schemas/PublishTestRequestRequest"
8761
- }
8762
- },
8763
- "application/x-www-form-urlencoded": {
8764
- "schema": {
8765
- "$ref": "#/components/schemas/PublishTestRequestRequest"
8766
- }
8767
- },
8768
- "multipart/form-data": {
8769
- "schema": {
8770
- "$ref": "#/components/schemas/PublishTestRequestRequest"
8771
- }
8772
- }
8773
- },
8774
- "required": true
8775
- },
8776
- "responses": {
8777
- "200": {
8778
- "content": {
8779
- "application/json": {
8780
- "schema": {
8781
- "$ref": "#/components/schemas/PublishTestResponse"
8782
- }
8783
- }
8784
- },
8785
- "description": ""
8786
- },
8787
- "400": {
8788
- "content": {
8789
- "application/json": {
8790
- "schema": {
8791
- "description": "Invalid request"
8792
- }
8793
- }
8794
- },
8795
- "description": ""
8796
- },
8797
- "500": {
8798
- "content": {
8799
- "application/json": {
8800
- "schema": {
8801
- "description": "Server error"
8802
- }
8803
- }
8804
- },
8805
- "description": ""
8806
- }
8807
- },
8808
- "security": [
8809
- {
8810
- "jwtAuth": []
8811
- }
8812
- ],
8813
- "summary": "Publish with database logging",
8814
- "tags": [
8815
- "Centrifugo Testing"
8816
- ],
8817
- "x-async-capable": false
8818
- }
8819
- },
8820
- "/cfg/centrifugo/admin/api/testing/send-ack/": {
8821
- "post": {
8822
- "description": "Manually send ACK for a message to the wrapper. Pass message_id in request body.",
8823
- "operationId": "cfg_centrifugo_admin_api_testing_send_ack_create",
8824
- "requestBody": {
8825
- "content": {
8826
- "application/json": {
8827
- "schema": {
8828
- "$ref": "#/components/schemas/ManualAckRequestRequest"
8829
- }
8830
- },
8831
- "application/x-www-form-urlencoded": {
8832
- "schema": {
8833
- "$ref": "#/components/schemas/ManualAckRequestRequest"
8834
- }
8835
- },
8836
- "multipart/form-data": {
8837
- "schema": {
8838
- "$ref": "#/components/schemas/ManualAckRequestRequest"
8839
- }
8840
- }
8841
- },
8842
- "required": true
8843
- },
8844
- "responses": {
8845
- "200": {
8846
- "content": {
8847
- "application/json": {
8848
- "schema": {
8849
- "$ref": "#/components/schemas/ManualAckResponse"
8850
- }
8851
- }
8852
- },
8853
- "description": ""
8854
- },
8855
- "400": {
8856
- "content": {
8857
- "application/json": {
8858
- "schema": {
8859
- "description": "Invalid request"
8860
- }
8861
- }
8862
- },
8863
- "description": ""
8864
- },
8865
- "500": {
8866
- "content": {
8867
- "application/json": {
8868
- "schema": {
8869
- "description": "Server error"
8870
- }
8871
- }
8872
- },
8873
- "description": ""
8874
- }
8875
- },
8876
- "security": [
8877
- {
8878
- "jwtAuth": []
8879
- }
8880
- ],
8881
- "summary": "Send manual ACK",
8882
- "tags": [
8883
- "Centrifugo Testing"
8884
- ],
8885
- "x-async-capable": false
8886
- }
8887
- },
8888
8049
  "/cfg/centrifugo/monitor/channels/": {
8889
8050
  "get": {
8890
8051
  "description": "Get statistics per channel.",