-
Notifications
You must be signed in to change notification settings - Fork 3
/
openapi.json
1076 lines (1076 loc) · 35.1 KB
/
openapi.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.3",
"info": {
"version": "0.24",
"title": "Client Example",
"description": "Client Example"
},
"paths": {
"/api/config-manager/0x24/runtime-apps-config": {
"get": {
"summary": "Config Manager: Runtime Apps Config",
"description": "Returns the runtime config for the Apps running on this server",
"parameters": [
{
"name": "url",
"in": "query",
"required": false,
"description": "URL used to reach this server, informative",
"schema": {
"type": "string"
}
},
{
"name": "expand_events",
"in": "query",
"required": false,
"description": "Retrieve expanded effective events from event steps",
"schema": {
"type": "boolean"
}
},
{
"name": "X-Track-Request-Id",
"in": "header",
"required": false,
"description": "Track information: Request-Id",
"schema": {
"type": "string"
}
},
{
"name": "X-Track-Request-Ts",
"in": "header",
"required": false,
"description": "Track information: Request-Ts",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Config info about running apps in current process",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeApps"
}
}
}
}
},
"tags": [
"config_manager.0x24"
]
}
},
"/api/config-manager/0x24/cluster-apps-config": {
"get": {
"summary": "Config Manager: Cluster Apps Config",
"description": "Handle remote access to runtime configuration for a group of hosts",
"parameters": [
{
"name": "hosts",
"in": "query",
"required": true,
"description": "Comma-separated list of http://host:port strings",
"schema": {
"type": "string"
}
},
{
"name": "expand_events",
"in": "query",
"required": true,
"description": "Extract effective events from event steps",
"schema": {
"type": "boolean"
}
},
{
"name": "X-Track-Request-Id",
"in": "header",
"required": false,
"description": "Track information: Request-Id",
"schema": {
"type": "string"
}
},
{
"name": "X-Track-Request-Ts",
"in": "header",
"required": false,
"description": "Track information: Request-Ts",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Combined config info about running apps in provided list of hosts",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeApps"
}
}
}
}
},
"tags": [
"config_manager.0x24"
]
}
},
"/api/client-example/0x24/call-unsecured": {
"get": {
"summary": "Client Example: Call Unsecured",
"description": "List all available Something objects connecting to simple-example app",
"parameters": [
{
"name": "wildcard",
"in": "query",
"required": false,
"description": "Wildcard to filter objects by name prefixed by partition folder in format YYYY/MM/DD/HH/*",
"schema": {
"type": "string"
}
},
{
"name": "X-Track-Request-Id",
"in": "header",
"required": false,
"description": "Track information: Request-Id",
"schema": {
"type": "string"
}
},
{
"name": "X-Track-Request-Ts",
"in": "header",
"required": false,
"description": "Track information: Request-Ts",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "X-Track-Caller",
"in": "header",
"required": true,
"description": "Track information: track.caller",
"schema": {
"type": "string",
"default": "test.caller"
}
},
{
"name": "X-Track-Session-Id",
"in": "header",
"required": true,
"description": "Track information: track.session_id",
"schema": {
"type": "string",
"default": "test.session_id"
}
}
],
"responses": {
"200": {
"description": "List Something objects returned by simple-example call",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Something"
}
}
}
}
}
},
"tags": [
"client_example.0x24"
]
}
},
"/api/client-example/0x24/count-and-save": {
"get": {
"summary": "Client Example: Count Objects and Save new one",
"description": "Count all available Something objects connecting to simple-example app",
"parameters": [
{
"name": "wildcard",
"in": "query",
"required": false,
"description": "Wildcard to filter objects by name prefixed by partition folder in format YYYY/MM/DD/HH/*",
"schema": {
"type": "string"
}
},
{
"name": "X-Track-Request-Id",
"in": "header",
"required": false,
"description": "Track information: Request-Id",
"schema": {
"type": "string"
}
},
{
"name": "X-Track-Request-Ts",
"in": "header",
"required": false,
"description": "Track information: Request-Ts",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "X-Track-Caller",
"in": "header",
"required": true,
"description": "Track information: track.caller",
"schema": {
"type": "string",
"default": "test.caller"
}
},
{
"name": "X-Track-Session-Id",
"in": "header",
"required": true,
"description": "Track information: track.session_id",
"schema": {
"type": "string",
"default": "test.session_id"
}
}
],
"responses": {
"200": {
"description": "Count of Something objects returned by simple-example call",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountAndSaveResult"
}
}
}
}
},
"tags": [
"client_example.0x24"
],
"security": [
{
"auth.basic": []
}
]
}
},
"/api/client-example/0x24/handle-responses": {
"get": {
"summary": "Client Example: Handle Responses",
"description": "Non default responses and UnhandledResponse exception\n\nTo manage different types of responses from the same endpoint we can use the `responses` parameter where we list the\nhttp response status codes expected and the corresponding data type for each one. In this example `app_call` expect\nand handle, 200 and 404 responses.\n\nAlso in the code you can see how to handle an expection of type `UnhandledResponse` and log as warining.",
"parameters": [
{
"name": "item_id",
"in": "query",
"required": true,
"description": "Item Id to read",
"schema": {
"type": "string"
}
},
{
"name": "partition_key",
"in": "query",
"required": true,
"description": "Partition folder in `YYYY/MM/DD/HH` format",
"schema": {
"type": "string"
}
},
{
"name": "X-Track-Request-Id",
"in": "header",
"required": false,
"description": "Track information: Request-Id",
"schema": {
"type": "string"
}
},
{
"name": "X-Track-Request-Ts",
"in": "header",
"required": false,
"description": "Track information: Request-Ts",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "X-Track-Caller",
"in": "header",
"required": true,
"description": "Track information: track.caller",
"schema": {
"type": "string",
"default": "test.caller"
}
},
{
"name": "X-Track-Session-Id",
"in": "header",
"required": true,
"description": "Track information: track.session_id",
"schema": {
"type": "string",
"default": "test.session_id"
}
}
],
"responses": {
"200": {
"description": "Show the response of the call",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"handle_responses"
],
"properties": {
"handle_responses": {
"type": "string"
}
},
"description": "handle_responses string payload"
}
}
}
}
},
"tags": [
"client_example.0x24"
],
"security": [
{
"auth.basic": []
}
]
}
}
},
"components": {
"schemas": {
"RuntimeAppInfo": {
"type": "object",
"required": [
"servers",
"app_config",
"effective_events"
],
"properties": {
"servers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServerInfo"
}
},
"app_config": {
"$ref": "#/components/schemas/AppConfig"
},
"effective_events": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/EventDescriptor"
}
}
},
"x-module-name": "hopeit.config_manager",
"description": "\n Application config information associated to servers at runtime\n "
},
"ServerInfo": {
"type": "object",
"required": [
"host_name",
"pid"
],
"properties": {
"host_name": {
"type": "string"
},
"pid": {
"type": "string"
},
"url": {
"type": "string",
"default": "in-process"
}
},
"x-module-name": "hopeit.config_manager",
"description": "\n Server info associated with runtime apps\n "
},
"AppConfig": {
"type": "object",
"required": [
"app"
],
"properties": {
"app": {
"$ref": "#/components/schemas/AppDescriptor"
},
"engine": {
"$ref": "#/components/schemas/AppEngineConfig",
"default": {
"import_modules": null,
"read_stream_timeout": 1000,
"read_stream_interval": 1000,
"default_stream_compression": "lz4",
"default_stream_serialization": "json+base64",
"track_headers": [
"track.request_id",
"track.request_ts"
],
"cors_origin": null
}
},
"app_connections": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/AppConnection"
},
"default": {}
},
"env": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
}
},
"default": {}
},
"events": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/EventDescriptor"
},
"default": {}
},
"server": {
"$ref": "#/components/schemas/ServerConfig"
},
"plugins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppDescriptor"
},
"default": []
},
"settings": {
"type": "object",
"additionalProperties": {
"type": "object"
},
"default": {}
},
"effective_settings": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"x-module-name": "hopeit.app.config",
"description": "\n App Configuration container\n "
},
"AppDescriptor": {
"type": "object",
"required": [
"name",
"version"
],
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
},
"x-module-name": "hopeit.app.config",
"description": "\n App descriptor\n "
},
"AppEngineConfig": {
"type": "object",
"properties": {
"import_modules": {
"type": "array",
"items": {
"type": "string"
}
},
"read_stream_timeout": {
"type": "integer",
"default": 1000
},
"read_stream_interval": {
"type": "integer",
"default": 1000
},
"default_stream_compression": {
"type": "string",
"enum": [
"none",
"lz4",
"lz4:0",
"lz4:16",
"zip",
"zip:1",
"zip:9",
"gzip",
"gzip:1",
"gzip:9",
"bz2",
"bz2:1",
"bz2:9",
"lzma"
],
"x-enum-name": "Compression",
"x-module-name": "hopeit.app.config",
"default": "lz4"
},
"default_stream_serialization": {
"type": "string",
"enum": [
"json",
"json+base64",
"pickle:3",
"pickle:4",
"pickle:5"
],
"x-enum-name": "Serialization",
"x-module-name": "hopeit.app.config",
"default": "json+base64"
},
"track_headers": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"cors_origin": {
"type": "string"
}
},
"x-module-name": "hopeit.app.config",
"description": "\n Engine specific parameters shared among events\n\n :field import_modules: list of string with the python module names to import to find\n events and datatype implementations\n :field read_stream_timeout: timeout in milliseconds to block connection pool when waiting for stream events\n :field read_stream_interval: delay in milliseconds to wait before attempting a new batch. Use to prevent\n connection pool to be blocked constantly.\n :track_headers: list of required X-Track-* headers\n :cors_origin: allowed CORS origin for web server\n "
},
"AppConnection": {
"type": "object",
"required": [
"name",
"version"
],
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"client": {
"type": "string",
"default": "<<NO CLIENT CONFIGURED>>"
},
"settings": {
"type": "string"
},
"plugin_name": {
"type": "string"
},
"plugin_version": {
"type": "string"
}
},
"x-module-name": "hopeit.app.config",
"description": "\n AppConnections: metadata to initialize app client in order to connect\n and issue requests to other running apps\n\n :field: name, str: target app name to connect to\n :field: version, str: target app version\n :field: client, str: hopeit.app.client.Client class implementation, from available client plugins\n :field: settings, optional str: key under `settings` section of app config containing connection configuration,\n if not specified, plugin will lookup its default section usually the plugin name. But in case multiple\n clients need to be configured, this value can be overridden.\n "
},
"EventDescriptor": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"GET",
"POST",
"STREAM",
"SERVICE",
"MULTIPART",
"SETUP"
],
"x-enum-name": "EventType",
"x-module-name": "hopeit.app.config"
},
"plug_mode": {
"type": "string",
"enum": [
"Standalone",
"OnApp"
],
"x-enum-name": "EventPlugMode",
"x-module-name": "hopeit.app.config",
"default": "Standalone"
},
"route": {
"type": "string"
},
"impl": {
"type": "string"
},
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventConnection"
},
"default": []
},
"read_stream": {
"$ref": "#/components/schemas/ReadStreamDescriptor"
},
"write_stream": {
"$ref": "#/components/schemas/WriteStreamDescriptor"
},
"auth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Unsecured",
"Basic",
"Bearer",
"Refresh"
],
"x-enum-name": "AuthType",
"x-module-name": "hopeit.server.config"
},
"default": []
},
"setting_keys": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"dataobjects": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"group": {
"type": "string",
"default": "DEFAULT"
}
},
"x-module-name": "hopeit.app.config",
"description": "\n Event Descriptor: configures event implementation\n\n :field: type, EventType: type of event i.e.: GET, POST, MULTIPART, STREAM, SERVICE, SETUP\n :field: plug_mode, EventPlugMode: defines whether an event defined in a plugin is created in the\n current app (ON_APP) or it will be created in the original plugin (STANDALONE, default)\n :field: route, optional str: custom route for endpoint. If not specified route will be derived\n from `/api/app_name/app_version/event_name`\n :field: impl, optional str: custom event implementation Python module. If not specified, module\n with same same as event will be imported.\n :field: connections, list of EventConnection: specifies dependencies on other apps/endpoints,\n that can be used by client plugins to call events on external apps\n :field: read_stream, optional ReadStreamDescriptor: specifies source stream to read from.\n Valid only for STREAM events.\n :field: write_stream, optional WriteStreamDescriptor: for any type of events, resultant dataobjects will\n be published to the specified stream.\n :field: auth, list of AuthType: supported authentication schemas for this event. If not specified\n application default will be used.\n :field: setting_keys, list of str: by default EventContext will have access to the settings section\n with the same name of the event using `settings = context.settings(datatype=MySettingsType)`.\n In case additional sections are needed to be accessed from\n EventContext, then a list of setting keys, including the name of the event if needed,\n can be specified here. Then access to a `custom` key can be done using\n `custom_settings = context.settings(key=\"customer\", datatype=MyCustomSettingsType)`\n :field: dataobjects, list of str: list of full qualified dataobject types that this event can process.\n When not specified, the engine will inspect the module implementation and find all datatypes supported\n as payload in the functions defined as `__steps__`. In case of generic functions that support\n `payload: DataObject` argument, then a list of full qualified datatypes must be specified here.\n :field: group, str: group name, if none is assigned it is automatically assigned as 'DEFAULT'.\n "
},
"EventConnection": {
"type": "object",
"required": [
"app_connection",
"event",
"type"
],
"properties": {
"app_connection": {
"type": "string"
},
"event": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"GET",
"POST"
],
"x-enum-name": "EventConnectionType",
"x-module-name": "hopeit.app.config"
}
},
"x-module-name": "hopeit.app.config",
"description": "\n EventConnection: describes dependencies on this event when calling\n event on apps configured in `app_connections` sections. Only events\n specified are allowed to be invoked using `hopeit.client`\n\n :field: app_connection, str: key of app entry used in app_connections sections\n :field: event, str: target event_name to be called\n :filed: type, EventConnectionType: a valid event connection type, i.e. GET or POST\n :field: route, optional str: custom route in case event is not attached to default `app/version/event`\n "
},
"ReadStreamDescriptor": {
"type": "object",
"required": [
"name",
"consumer_group"
],
"properties": {
"name": {
"type": "string"
},
"consumer_group": {
"type": "string"
},
"queues": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"AUTO"
]
}
},
"x-module-name": "hopeit.app.config",
"description": "\n Configuration to read streams\n\n :field stream_name: str, base stream name to read\n :consumer_group: str, consumer group to send to stream processing engine to keep track of\n next messag to consume\n :queues: List[str], list of queue names to poll from. Each queue act as separate stream\n with queue name used as stream name suffix, where `AUTO` queue name means to consume\n events when no queue where specified at publish time, allowing to consume message with different\n priorities without waiting for all events in the stream to be consumed.\n Queues specified in this entry will be consumed by this event\n on each poll cycle, on the order specified. If not present\n only AUTO queue will be consumed. Take into account that in applications using multiple\n queue names, in order to ensure all messages are consumed, all queue names should be listed\n here including AUTO, except that the app is intentionally designed for certain events to\n consume only from specific queues. This configuration is manual to allow consuming messages\n produced by external apps.\n "
},
"WriteStreamDescriptor": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"queues": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"AUTO"
]
},
"queue_strategy": {
"type": "string",
"enum": [
"PROPAGATE",
"DROP"
],
"x-enum-name": "StreamQueueStrategy",
"x-module-name": "hopeit.app.config",
"default": "DROP"
}
},
"x-module-name": "hopeit.app.config",
"description": "\n Configuration to publish messages to a stream\n\n :field: name, str: stream name\n :field: queue, List[str], queue names to be used to publish to stream.\n Each queue act as separate stream with queue name used as stream name suffix,\n allowing to publish messages to i.e. a queue that will be consumed with priority,\n or to multiple queues that will be consumed by different readers.\n Queue suffix will be propagated through events, allowing an event in a defined queue\n and successive events in following steps to be consumed using same queue name.\n Notice that queue will be applied only to messages coming from default queue\n (where queue is not specified at intial message creation). Messages consumed\n from other queues will be published using same queue name as they have when consumed.\n :field queue_stategory: strategy to be used when consuming messages from a stream\n with a queue name and publishing to another stream. Default is `StreamQueueStrategy.DROP`,\n so in case of complex stream propagating queue names are configured,\n `StreamQueueStrategy.PROPAGATE` must be explicitly specified.\n "
},
"ServerConfig": {
"type": "object",
"properties": {
"streams": {
"$ref": "#/components/schemas/StreamsConfig",
"default": {
"stream_manager": "hopeit.streams.NoStreamManager",
"connection_str": "<<NoStreamManager>>",
"delay_auto_start_seconds": 3,
"initial_backoff_seconds": 1.0,
"max_backoff_seconds": 60.0,
"num_failures_open_circuit_breaker": 1
}
},
"logging": {
"$ref": "#/components/schemas/LoggingConfig",
"default": {
"log_level": "INFO",
"log_path": "logs/"
}
},
"auth": {
"$ref": "#/components/schemas/AuthConfig",
"default": {
"secrets_location": ".secrets/",
"auth_passphrase": "",
"enabled": false,
"create_keys": false,
"domain": null,
"encryption_algorithm": "RS256",
"default_auth_methods": [
"Unsecured"
]
}
},
"api": {
"$ref": "#/components/schemas/APIConfig",
"default": {
"docs_path": null
}
},
"engine_version": {
"type": "string",
"default": "0.24.0"
}
},
"x-module-name": "hopeit.server.config",
"description": "\n Server configuration\n "
},
"StreamsConfig": {
"type": "object",
"properties": {
"stream_manager": {
"type": "string",
"default": "hopeit.streams.NoStreamManager"
},
"connection_str": {
"type": "string",
"default": "<<NoStreamManager>>"
},
"delay_auto_start_seconds": {
"type": "integer",
"default": 3
},
"initial_backoff_seconds": {
"type": "number",
"default": 1.0
},
"max_backoff_seconds": {
"type": "number",
"default": 60.0
},
"num_failures_open_circuit_breaker": {
"type": "integer",
"default": 1
}
},
"x-module-name": "hopeit.server.config",
"description": "\n :field connection_str: str, url to connect to streams server: i.e. redis://localhost:6379\n if using redis stream manager plugin to connect locally\n "
},
"LoggingConfig": {
"type": "object",
"properties": {
"log_level": {
"type": "string",
"default": "INFO"
},
"log_path": {
"type": "string",
"default": "logs/"
}
},
"x-module-name": "hopeit.server.config",
"description": "LoggingConfig(log_level: str = 'INFO', log_path: str = 'logs/')"
},
"AuthConfig": {
"type": "object",
"required": [
"secrets_location",
"auth_passphrase"
],
"properties": {
"secrets_location": {
"type": "string"
},
"auth_passphrase": {
"type": "string"
},
"enabled": {
"type": "boolean",
"default": true
},
"create_keys": {
"type": "boolean",
"default": false
},
"domain": {
"type": "string"
},
"encryption_algorithm": {
"type": "string",
"default": "RS256"
},
"default_auth_methods": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Unsecured",
"Basic",
"Bearer",
"Refresh"
],
"x-enum-name": "AuthType",
"x-module-name": "hopeit.server.config"
},
"default": []
}
},
"x-module-name": "hopeit.server.config",
"description": "\n Server configuration to handle authorization tokens\n "
},
"APIConfig": {
"type": "object",
"properties": {
"docs_path": {
"type": "string"
}
},
"x-module-name": "hopeit.server.config",
"description": "\n Config for Open API docs page\n "
},
"RuntimeApps": {
"type": "object",
"required": [
"apps"
],
"properties": {
"apps": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/RuntimeAppInfo"
}
},
"server_status": {
"type": "object",
"additionalProperties": {
"type": "string",
"enum": [
"ALIVE",
"ERROR"
],
"x-enum-name": "ServerStatus",
"x-module-name": "hopeit.config_manager"
},
"default": {}
}
},
"x-module-name": "hopeit.config_manager",
"description": "\n Combined App Config and Server Status information for running apps\n "
},
"User": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"x-module-name": "model",
"description": "User information"
},
"Status": {
"type": "object",
"required": [
"ts",
"type"
],
"properties": {
"ts": {