forked from Aiven-Open/klaw
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
1639 lines (1639 loc) · 45.2 KB
/
openapi.yaml
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:
title: Klaw - OpenAPI
version: 1.0.0
description: >
This specification is still a work in progress and is not yet implemented in any API. The purpose of this
specification is to facilitate developers discussions.
contact:
email: info@klaw-project.io
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
externalDocs:
description: Klaw documentation
url: https://www.klaw-project.io/docs
tags:
- name: User
description: User API endpoints
- name: Topic
description: Topic API endpoints
- name: Team
description: Team API endpoints
- name: Environment
description: Environment API endpoints
- name: ACL
description: ACL (Access Control List) API endpoints on topics and consumer groups
- name: SchemaRequest
description: SchemaRequest API endpoints
paths:
/user/authenticate:
summary: User authentication
description: User can authenticate themselves with their username and password
post:
operationId: userAuthentication
summary: Authenticate user
description: >
Exchange username and password to an authentication token.
The token can be later used as authentication mechanism for other API endpoints.
tags:
- User
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserAuthenticationRequest"
responses:
"200":
description: Successful authentication
content:
application/json:
schema:
$ref: "#/components/schemas/UserAuthenticationResponse"
"403":
description: Invalid credentials
content:
application/json:
schema:
$ref: "#/components/schemas/CommonError"
example:
message: Username and password did not match
/getTopics:
get:
operationId: topicsGet
summary: Get topics
tags:
- Topic
parameters:
- in: query
name: env
required: true
description: The value should be either an environment identifier or "ALL".
schema:
type: string
example: "ALL"
- in: query
name: pageNo
required: true
schema:
type: string
example: "1"
- in: query
name: currentPage
required: false
schema:
type: string
example: "1"
- in: query
name: topicnamesearch
required: false
schema:
type: string
example: searchTerm
- in: query
name: teamName
required: false
schema:
type: string
example: application-X-developers
- in: query
name: topicType
required: false
schema:
type: string
enum: ["Producer", "Consumer"]
example: "Producer"
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/TopicsGetResponse"
/getTopicsOnly:
get:
operationId: topicsGetOnly
summary: Get topic names list
tags:
- Topic
parameters:
- name: isMyTeamTopics
in: query
required: false
description: Set to true to only get the topic names for topics belonging to the team of the current user
schema:
$ref: "#/components/schemas/TopicsGetOnlyResponse"
- name: envSelected
in: query
required: false
description: Pass an environment ID to get only the names of the topics in that environment
schema:
$ref: "#/components/schemas/TopicsGetOnlyResponse"
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: string
/getTopicTeam:
get:
operationId: topicGetTeam
summary: Get the name of the team a topic belongs to
tags:
- Topic
parameters:
- name: topicName
in: query
required: true
description: The name of the topic
schema:
type: string
- name: patternType
in: query
required: false
description: The pattern type of the topic
schema:
type: string
enum: ["LITERAL", "PREFIXED"]
default: "LITERAL"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/TopicGetTeamResponse"
/createTopics:
post:
operationId: topicCreate
summary: Create topic request
tags:
- Topic
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/topicCreateRequest"
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/GenericApiResponse"
/getAdvancedTopicConfigs:
get:
operationId: topicAdvancedConfigGet
summary: Get advanced topic configuration options
tags:
- Topic
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/topicAdvancedConfigGetResponse"
/getAllTeamsSUOnly:
get:
operationId: teamNamesGet
summary: Get team names
tags:
- Team
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/TeamNamesGetResponse"
/getAllTeamsSU:
get:
operationId: teamsGet
summary: Get teams
tags:
- Team
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/TeamsGetResponse"
/getEnvs:
get:
operationId: environmentsGet
summary: Get environments
tags:
- Environment
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Environment"
/getEnvsBaseClusterFilteredForTeam:
get:
operationId: envsBaseClusterFilteredForTeamGet
summary: Get environments
tags:
- Environment
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Environment"
/getClusterInfoFromEnv:
get:
operationId: clusterInfoFromEnvironmentGet
summary: "Get flavor of Kafka cluster (Aiven cluster or other type of cluster)"
tags:
- Environment
parameters:
- name: envSelected
in: query
required: true
description: The environment for which to get the cluster info
schema:
type: string
example: "2"
- name: envType
in: query
required: true
description: The type of environment for which to get the cluster info
schema:
type: string
enum: [kafka, kafkaconnect, schema]
example: kafka
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/environmentGetClusterInfoResponse"
/getAclRequestsForApprover:
get:
operationId: getAclRequestsForApprover
summary: "Get ACL requests with aclstatus: created"
tags:
- ACL
parameters:
- name: pageNo
in: query
required: true
schema:
type: string
- name: currentPage
in: query
required: false
schema:
type: string
- name: requestStatus
in: query
required: false
schema:
$ref: "#/components/schemas/RequestStatus"
example: "CREATED"
- name: topic
in: query
required: false
schema:
type: string
example: "mytopic"
- name: env
in: query
required: false
schema:
type: string
example: "1"
- name: aclType
in: query
required: false
schema:
type: string
enum: ["CONSUMER", "PRODUCER"]
example: "CONSUMER"
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/aclRequest"
/execAclRequest:
post:
tags:
- ACL
operationId: approveAclRequests
summary: Approve an ACL request
parameters:
- name: req_no
in: query
required: true
schema:
type: string
example: "1008"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/GenericApiResponse"
/execAclRequestDecline:
post:
tags:
- ACL
operationId: declineAclRequests
summary: Decline an ACL request
parameters:
- name: req_no
in: query
required: true
description: "reqNo of the ACL request"
schema:
type: string
example: "1008"
- name: reasonForDecline
in: query
required: true
description: "Stated reason for declining request (URL formatted string)"
schema:
type: string
example: "I+don%27t+know+why+you+need+access"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/GenericApiResponse"
/createAcl:
post:
tags:
- ACL
operationId: createAclRequest
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/aclRequest"
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/GenericApiResponse"
/getSchemaRegEnvs:
get:
operationId: schemaRegEnvsGet
summary: get schema registry environments
tags:
- SchemaRequest
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Environment"
/uploadSchema:
post:
operationId: schemaUpload
summary: post schema upload
tags:
- SchemaRequest
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/SchemaRequest"
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/GenericApiResponse"
/getTopicRequestsForApprover:
get:
operationId: getTopicRequestsForApprover
parameters:
- name: pageNo
in: query
required: true
example: "2"
schema:
type: string
- name: currentPage
in: query
example: "2"
schema:
type: string
- name: requestStatus
in: query
example: "CREATED"
schema:
$ref: "#/components/schemas/RequestStatus"
- name: teamId
in: query
schema:
type: integer
format: int32
example: 1001
- name: env
in: query
schema:
type: string
example: "1"
- name: search
in: query
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/TopicRequest"
/getAuth:
get:
operationId: getAuth
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GetAuthResponse"
/request/approve:
post:
operationId: approveRequest
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RequestVerdict"
required: false
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/GenericApiResponse"
x-codegen-request-body-name: body
/request/decline:
post:
operationId: declineRequest
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RequestVerdict"
required: false
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/GenericApiResponse"
x-codegen-request-body-name: body
/getSchemaRequestsForApprover:
get:
operationId: getSchemaRequestsForApprover
parameters:
- name: pageNo
in: query
required: true
example: "1"
schema:
type: string
- name: currentPage
in: query
example: "1"
schema:
type: string
- name: requestStatus
in: query
schema:
$ref: "#/components/schemas/RequestStatus"
example: "CREATED"
- name: topic
description: Name of a topic
example: "testtopic1"
in: query
schema:
type: string
- name: env
in: query
description: Environment identifier
example: "3"
schema:
type: string
- name: search
in: query
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/SchemaRequest"
components:
schemas:
CommonError:
type: object
properties:
message:
title: message
description: Description for user why a certain operation failed
type: string
GenericApiResponse:
title: GenericApiResponse
type: object
properties:
status:
type: string
enum:
- 100 CONTINUE
- 101 SWITCHING_PROTOCOLS
- 102 PROCESSING
- 103 CHECKPOINT
- 200 OK
- 201 CREATED
- 202 ACCEPTED
- 203 NON_AUTHORITATIVE_INFORMATION
- 204 NO_CONTENT
- 205 RESET_CONTENT
- 206 PARTIAL_CONTENT
- 207 MULTI_STATUS
- 208 ALREADY_REPORTED
- 226 IM_USED
- 300 MULTIPLE_CHOICES
- 301 MOVED_PERMANENTLY
- 302 FOUND
- 302 MOVED_TEMPORARILY
- 303 SEE_OTHER
- 304 NOT_MODIFIED
- 305 USE_PROXY
- 307 TEMPORARY_REDIRECT
- 308 PERMANENT_REDIRECT
- 400 BAD_REQUEST
- 401 UNAUTHORIZED
- 402 PAYMENT_REQUIRED
- 403 FORBIDDEN
- 404 NOT_FOUND
- 405 METHOD_NOT_ALLOWED
- 406 NOT_ACCEPTABLE
- 407 PROXY_AUTHENTICATION_REQUIRED
- 408 REQUEST_TIMEOUT
- 409 CONFLICT
- 410 GONE
- 411 LENGTH_REQUIRED
- 412 PRECONDITION_FAILED
- 413 PAYLOAD_TOO_LARGE
- 413 REQUEST_ENTITY_TOO_LARGE
- 414 URI_TOO_LONG
- 414 REQUEST_URI_TOO_LONG
- 415 UNSUPPORTED_MEDIA_TYPE
- 416 REQUESTED_RANGE_NOT_SATISFIABLE
- 417 EXPECTATION_FAILED
- 418 I_AM_A_TEAPOT
- 419 INSUFFICIENT_SPACE_ON_RESOURCE
- 420 METHOD_FAILURE
- 421 DESTINATION_LOCKED
- 422 UNPROCESSABLE_ENTITY
- 423 LOCKED
- 424 FAILED_DEPENDENCY
- 425 TOO_EARLY
- 426 UPGRADE_REQUIRED
- 428 PRECONDITION_REQUIRED
- 429 TOO_MANY_REQUESTS
- 431 REQUEST_HEADER_FIELDS_TOO_LARGE
- 451 UNAVAILABLE_FOR_LEGAL_REASONS
- 500 INTERNAL_SERVER_ERROR
- 501 NOT_IMPLEMENTED
- 502 BAD_GATEWAY
- 503 SERVICE_UNAVAILABLE
- 504 GATEWAY_TIMEOUT
- 505 HTTP_VERSION_NOT_SUPPORTED
- 506 VARIANT_ALSO_NEGOTIATES
- 507 INSUFFICIENT_STORAGE
- 508 LOOP_DETECTED
- 509 BANDWIDTH_LIMIT_EXCEEDED
- 510 NOT_EXTENDED
- 511 NETWORK_AUTHENTICATION_REQUIRED
timestamp:
title: Timestamp
type: string
format: date-time
example: 2018-11-13T20:20:39+00:00
message:
type: string
debugMessage:
type: string
result:
type: string
data:
type: object
RequestOperationType:
title: Type of request operation
type: string
enum:
- CREATE
- UPDATE
- DELETE
- CLAIM
- PROMOTE
example: UPDATE
RequestStatus:
type: string
title: Status of a request
enum:
- CREATED
- DELETED
- DECLINED
- APPROVED
- ALL
example: CREATED
UserAuthenticationRequest:
type: object
required:
- username
- password
properties:
username:
type: string
title: username
description: Username
example: john.doe@klaw-project.io
password:
title: password
type: string
example: password123
UserAuthenticationResponse:
type: object
required:
- token
- tokenType
properties:
token:
title: token
description: Klaw authentication token
type: string
minLength: 256
maxLength: 2048
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
tokenType:
title: Token type
example: JWT
type: string
enum: [JWT]
TopicsGetResponse:
type: array
items:
type: array
items:
$ref: "#/components/schemas/TopicInfo"
TopicsGetOnlyResponse:
type: array
items:
type: string
example: ["myTopic", "otherTopic"]
TopicGetTeamResponse:
type: object
properties:
team:
type: string
required: [team]
example: { "team": "Team A" }
TopicInfo:
type: object
additionalProperties: false
properties:
topicid:
title: Topic identifier
description: This identifier is used in Klaw metadata store to ensure uniquenes.
type: integer
format: int32
example: 1010
totalNoPages:
title: Total number of pages
type: string
example: "1"
currentPage:
title: Current page number
type: string
example: "1"
allPageNos:
title: All page numbers
description: List of all page numbers
type: array
items:
type: string
example: ["1"]
topicName:
title: Topic name
description: Kafka Topic name
type: string
example: "topicName"
noOfPartitions:
title: Number of partitions
description: Topic partition count
type: integer
format: int32
example: 10
description:
title: Description
description: Kafka topic description stored in Klaw metadata.
type: string
example: "Main PostgreSQL change data capture stream"
documentation:
title: Documentation
deprecated: true
nullable: true
type: string
noOfReplicas:
title: Number of replicas
description: Topic replica count
type: string
example: "2"
sequence:
title: Sequence
type: string
deprecated: true
teamname:
title: Team name
description: Topic owner team name
type: string
example: application-X-developers
cluster:
title: cluster
deprecated: true
type: string
example: "1"
clusterId:
title: Cluster identifier
type: string
deprecated: true
nullable: true
environmentsList:
title: Environments list
description: List of environments where the topic is present.
type: array
items:
title: Environment name
example: TEST
type: string
example: ["DEV", "TEST"]
showEditTopic:
title: Show edit topic
description: Describes if the user should see topic edit action.
type: boolean
example: false
showDeleteTopic:
title: Show delete topic
description: Describes if the user should see topic delete action.
type: boolean
example: true
topicDeletable:
title: Topic deletable
description: Describes if the topic can be deleted.
example: true
type: boolean
required:
[
allPageNos,
cluster,
clusterId,
currentPage,
description,
documentation,
environmentsList,
noOfPartitions,
noOfReplcias,
showDeleteTopic,
showEditTopic,
teamname,
topicDeletable,
topicid,
topicName,
totalNoPages,
]
TeamNamesGetResponse:
type: array
items:
title: Team name
type: string
example: Team A
example: ["All teams", "Team A", "Team B"]
TeamsGetResponse:
type: object
properties:
teamname:
type: string
pattern: "^[a-zA-z 0-9]*$"
teammail:
type: string
teamphone:
type: string
pattern: "(^$|[+]{0,1}[0-9]*)"
contactperson:
type: string
pattern: "^[A-Za-zÀ-ÖØ-öø-ÿ' ]*$"
tenantId:
type: integer
format: int32
teamId:
type: integer
format: int32
app:
type: string
showDeleteTeam:
type: boolean
tenantName:
type: string
envList:
type: array
items:
type: string
required:
- contactperson
- teamname
- teamphone
Environment:
type: object
properties:
id:
title: id
description: Environment identifier
type: string
example: "1"
name:
title: Name
description: Environment name
type: string
example: DEV
type:
title: Type
description: Environment type
type: string
enum: [kafka, kafkaconnect, schema]
tenantId:
title: TenantId
description: Tenant identifier
type: number
example: 101
topicprefix:
title: Topic prefix
description: Topic name prefix
type: string
nullable: true
example: "test-"
topicsuffix:
title: Topic suffix
description: Topic name suffix
type: string
nullable: true
example: "-test"
clusterId:
title: Cluster identifier
type: number
example: 1
tenantName:
title: Tenant name
type: string
example: default
clusterName:
title: Cluster name
type: string
example: DEV
envStatus:
title: Environment status
type: string
enum: [ONLINE, OFFLINE]
example: ONLINE
otherParams:
title: Other parameters
description: Topic configuration parameters
type: string
example: default.partitions=2,max.partitions=2,default.replication.factor=1,max.replication.factor=1,topic.prefix=,topic.suffix
defaultPartitions:
title: Default partitions
type: string
nullable: true
example: "1"
maxPartitions:
title: Maximum partitions
type: string
nullable: true
example: "2"
defaultReplicationFactor:
title: Default replication factor
type: string
nullable: true
example: "1"
maxReplicationFactor:
title: Maximum replication factor
type: string
nullable: true
example: "2"
showDeleteEnv:
title: Show delete environment
description: Describes if the user should see environment delete action.
type: boolean
example: true
totalNoPages:
title: Total number of pages
type: string
example: "1"
allPageNos:
title: All page numbers
description: List of all page numbers
type: array
items:
type: string
example: ["1"]
required:
[
id,
name,
type,
tenantId,
topicprefix,
topicsuffix,
clusterId,
tenantName,