Skip to content

Commit 0c3495d

Browse files
committed
Revert "format kafkbat-ui openapi definition"
This reverts commit 6ce7078.
1 parent b21d04e commit 0c3495d

File tree

1 file changed

+57
-37
lines changed

1 file changed

+57
-37
lines changed

contract/src/main/resources/swagger/kafbat-ui-api.yaml

Lines changed: 57 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ info:
44
version: 0.1.0
55
title: Api Documentation
66
termsOfService: urn:tos
7-
contact: {}
7+
contact: { }
88
license:
99
name: Apache 2.0
1010
url: https://www.apache.org/licenses/LICENSE-2.0
@@ -31,6 +31,7 @@ paths:
3131
items:
3232
$ref: '#/components/schemas/Cluster'
3333

34+
3435
/api/clusters/{clusterName}/cache:
3536
post:
3637
tags:
@@ -53,6 +54,7 @@ paths:
5354
404:
5455
description: Not found
5556

57+
5658
/api/clusters/{clusterName}/brokers:
5759
get:
5860
tags:
@@ -430,6 +432,7 @@ paths:
430432
404:
431433
description: Not found
432434

435+
433436
/api/clusters/{clusterName}/topics/{topicName}:
434437
get:
435438
tags:
@@ -641,6 +644,7 @@ paths:
641644
schema:
642645
$ref: '#/components/schemas/SmartFilterTestExecutionResult'
643646

647+
644648
/api/clusters/{clusterName}/topics/{topicName}/messages:
645649
get:
646650
tags:
@@ -661,7 +665,7 @@ paths:
661665
- name: seekType
662666
in: query
663667
schema:
664-
$ref: '#/components/schemas/SeekType'
668+
$ref: "#/components/schemas/SeekType"
665669
- name: seekTo
666670
in: query
667671
schema:
@@ -680,19 +684,19 @@ paths:
680684
- name: filterQueryType
681685
in: query
682686
schema:
683-
$ref: '#/components/schemas/MessageFilterType'
687+
$ref: "#/components/schemas/MessageFilterType"
684688
- name: seekDirection
685689
in: query
686690
schema:
687-
$ref: '#/components/schemas/SeekDirection'
691+
$ref: "#/components/schemas/SeekDirection"
688692
- name: keySerde
689693
in: query
690-
description: 'Serde that should be used for deserialization. Will be chosen automatically if not set.'
694+
description: "Serde that should be used for deserialization. Will be chosen automatically if not set."
691695
schema:
692696
type: string
693697
- name: valueSerde
694698
in: query
695-
description: 'Serde that should be used for deserialization. Will be chosen automatically if not set.'
699+
description: "Serde that should be used for deserialization. Will be chosen automatically if not set."
696700
schema:
697701
type: string
698702
responses:
@@ -789,6 +793,7 @@ paths:
789793
schema:
790794
$ref: '#/components/schemas/MessageFilterId'
791795

796+
792797
/api/clusters/{clusterName}/topics/{topicName}/messages/v2:
793798
get:
794799
tags:
@@ -810,7 +815,7 @@ paths:
810815
in: query
811816
description: Messages polling mode
812817
schema:
813-
$ref: '#/components/schemas/PollingMode'
818+
$ref: "#/components/schemas/PollingMode"
814819
- name: partitions
815820
in: query
816821
schema:
@@ -847,17 +852,17 @@ paths:
847852
format: int64
848853
- name: keySerde
849854
in: query
850-
description: 'Serde that should be used for deserialization. Will be chosen automatically if not set.'
855+
description: "Serde that should be used for deserialization. Will be chosen automatically if not set."
851856
schema:
852857
type: string
853858
- name: valueSerde
854859
in: query
855-
description: 'Serde that should be used for deserialization. Will be chosen automatically if not set.'
860+
description: "Serde that should be used for deserialization. Will be chosen automatically if not set."
856861
schema:
857862
type: string
858863
- name: cursor
859864
in: query
860-
description: 'id of the cursor for pagination, if passed - all other query params ignored'
865+
description: "id of the cursor for pagination, if passed - all other query params ignored"
861866
schema:
862867
type: string
863868
responses:
@@ -870,6 +875,7 @@ paths:
870875
items:
871876
$ref: '#/components/schemas/TopicMessageEvent'
872877

878+
873879
/api/clusters/{clusterName}/topics/{topicName}/activeproducers:
874880
get:
875881
tags:
@@ -897,6 +903,7 @@ paths:
897903
items:
898904
$ref: '#/components/schemas/TopicProducerState'
899905

906+
900907
/api/clusters/{clusterName}/topics/{topicName}/consumer-groups:
901908
get:
902909
tags:
@@ -969,6 +976,7 @@ paths:
969976
schema:
970977
$ref: '#/components/schemas/ConsumerGroupsPageResponse'
971978

979+
972980
/api/clusters/{clusterName}/consumer-groups/{id}:
973981
get:
974982
tags:
@@ -1200,6 +1208,7 @@ paths:
12001208
404:
12011209
description: Not found
12021210

1211+
12031212
/api/clusters/{clusterName}/schemas/{subject}/versions/{version}:
12041213
get:
12051214
tags:
@@ -2210,6 +2219,7 @@ paths:
22102219
schema:
22112220
$ref: '#/components/schemas/ApplicationConfigValidation'
22122221

2222+
22132223
/api/config/relatedfiles:
22142224
post:
22152225
tags:
@@ -2255,7 +2265,7 @@ components:
22552265
description:
22562266
type: string
22572267
preferred:
2258-
description: 'This serde was automatically chosen by cluster config. This should be enabled in UI by default. Also it will be used for deserialization if no serdes passed.'
2268+
description: "This serde was automatically chosen by cluster config. This should be enabled in UI by default. Also it will be used for deserialization if no serdes passed."
22592269
type: boolean
22602270
schema:
22612271
type: string
@@ -2542,7 +2552,7 @@ components:
25422552
partitions:
25432553
type: array
25442554
items:
2545-
$ref: '#/components/schemas/Partition'
2555+
$ref: "#/components/schemas/Partition"
25462556
required:
25472557
- name
25482558

@@ -2586,15 +2596,15 @@ components:
25862596
partitionStats:
25872597
type: array
25882598
items:
2589-
$ref: '#/components/schemas/TopicAnalysisStats'
2599+
$ref: "#/components/schemas/TopicAnalysisStats"
25902600

25912601
TopicAnalysisStats:
25922602
type: object
25932603
properties:
25942604
partition:
25952605
type: integer
25962606
format: int32
2597-
description: 'null if this is total stats'
2607+
description: "null if this is total stats"
25982608
totalMsgs:
25992609
type: integer
26002610
format: int64
@@ -2623,9 +2633,9 @@ components:
26232633
type: integer
26242634
format: int64
26252635
keySize:
2626-
$ref: '#/components/schemas/TopicAnalysisSizeStats'
2636+
$ref: "#/components/schemas/TopicAnalysisSizeStats"
26272637
valueSize:
2628-
$ref: '#/components/schemas/TopicAnalysisSizeStats'
2638+
$ref: "#/components/schemas/TopicAnalysisSizeStats"
26292639
hourlyMsgCounts:
26302640
type: array
26312641
items:
@@ -2640,7 +2650,7 @@ components:
26402650

26412651
TopicAnalysisSizeStats:
26422652
type: object
2643-
description: 'All sizes in bytes'
2653+
description: "All sizes in bytes"
26442654
properties:
26452655
sum:
26462656
type: integer
@@ -2690,7 +2700,7 @@ components:
26902700
partitions:
26912701
type: array
26922702
items:
2693-
$ref: '#/components/schemas/Partition'
2703+
$ref: "#/components/schemas/Partition"
26942704
partitionCount:
26952705
type: integer
26962706
replicationFactor:
@@ -2729,15 +2739,15 @@ components:
27292739
defaultValue:
27302740
type: string
27312741
source:
2732-
$ref: '#/components/schemas/ConfigSource'
2742+
$ref: "#/components/schemas/ConfigSource"
27332743
isSensitive:
27342744
type: boolean
27352745
isReadOnly:
27362746
type: boolean
27372747
synonyms:
27382748
type: array
27392749
items:
2740-
$ref: '#/components/schemas/ConfigSynonym'
2750+
$ref: "#/components/schemas/ConfigSynonym"
27412751
doc:
27422752
type: string
27432753
required:
@@ -2853,7 +2863,7 @@ components:
28532863
discriminator:
28542864
propertyName: inherit
28552865
mapping:
2856-
details: '#/components/schemas/ConsumerGroupDetails'
2866+
details: "#/components/schemas/ConsumerGroupDetails"
28572867
type: object
28582868
properties:
28592869
groupId:
@@ -2867,9 +2877,9 @@ components:
28672877
partitionAssignor:
28682878
type: string
28692879
state:
2870-
$ref: '#/components/schemas/ConsumerGroupState'
2880+
$ref: "#/components/schemas/ConsumerGroupState"
28712881
coordinator:
2872-
$ref: '#/components/schemas/Broker'
2882+
$ref: "#/components/schemas/Broker"
28732883
consumerLag:
28742884
type: integer
28752885
format: int64
@@ -2964,13 +2974,13 @@ components:
29642974
# otherwise ui should pass cursor param to continue polling
29652975
- DONE
29662976
message:
2967-
$ref: '#/components/schemas/TopicMessage'
2977+
$ref: "#/components/schemas/TopicMessage"
29682978
phase:
2969-
$ref: '#/components/schemas/TopicMessagePhase'
2979+
$ref: "#/components/schemas/TopicMessagePhase"
29702980
consuming:
2971-
$ref: '#/components/schemas/TopicMessageConsuming'
2981+
$ref: "#/components/schemas/TopicMessageConsuming"
29722982
cursor:
2973-
$ref: '#/components/schemas/TopicMessageNextPageCursor'
2983+
$ref: "#/components/schemas/TopicMessageNextPageCursor"
29742984

29752985
TopicMessagePhase:
29762986
type: object
@@ -3033,10 +3043,10 @@ components:
30333043
type: string
30343044
keyFormat:
30353045
#deprecated - wont be filled - use 'keySerde' field instead
3036-
$ref: '#/components/schemas/MessageFormat'
3046+
$ref: "#/components/schemas/MessageFormat"
30373047
valueFormat:
30383048
#deprecated - wont be filled - use 'valueSerde' field instead
3039-
$ref: '#/components/schemas/MessageFormat'
3049+
$ref: "#/components/schemas/MessageFormat"
30403050
keySize:
30413051
type: integer
30423052
format: int64
@@ -3162,6 +3172,7 @@ components:
31623172
- topic
31633173
- partition
31643174

3175+
31653176
ConsumerGroupDetails:
31663177
allOf:
31673178
- $ref: '#/components/schemas/ConsumerGroup'
@@ -3882,7 +3893,16 @@ components:
38823893

38833894
KafkaAcl:
38843895
type: object
3885-
required: [resourceType, resourceName, namePatternType, principal, host, operation, permission]
3896+
required:
3897+
[
3898+
resourceType,
3899+
resourceName,
3900+
namePatternType,
3901+
principal,
3902+
host,
3903+
operation,
3904+
permission,
3905+
]
38863906
properties:
38873907
resourceType:
38883908
$ref: '#/components/schemas/KafkaAclResourceType'
@@ -3899,15 +3919,15 @@ components:
38993919
enum:
39003920
- UNKNOWN # Unknown operation, need to update mapping code on BE
39013921
- ALL # Cluster, Topic, Group
3902-
- READ # Topic, Group
3922+
- READ # Topic, Group
39033923
- WRITE # Topic, TransactionalId
39043924
- CREATE # Cluster, Topic
3905-
- DELETE # Topic, Group
3906-
- ALTER # Cluster, Topic,
3925+
- DELETE # Topic, Group
3926+
- ALTER # Cluster, Topic,
39073927
- DESCRIBE # Cluster, Topic, Group, TransactionalId, DelegationToken
39083928
- CLUSTER_ACTION # Cluster
39093929
- DESCRIBE_CONFIGS # Cluster, Topic
3910-
- ALTER_CONFIGS # Cluster, Topic
3930+
- ALTER_CONFIGS # Cluster, Topic
39113931
- IDEMPOTENT_WRITE # Cluster
39123932
- CREATE_TOKENS
39133933
- DESCRIBE_TOKENS
@@ -4138,7 +4158,7 @@ components:
41384158
properties:
41394159
maxInMemoryBufferSize:
41404160
type: string
4141-
description: 'examples: 20, 12KB, 5MB'
4161+
description: "examples: 20, 12KB, 5MB"
41424162
kafka:
41434163
type: object
41444164
properties:
@@ -4195,7 +4215,7 @@ components:
41954215
keystoreLocation:
41964216
type: string
41974217
keystorePassword:
4198-
type: string
4218+
type: string
41994219
ksqldbServerAuth:
42004220
type: object
42014221
properties:
@@ -4303,7 +4323,7 @@ components:
43034323
properties:
43044324
level:
43054325
type: string
4306-
enum: ['ALL', 'ALTER_ONLY']
4326+
enum: [ "ALL", "ALTER_ONLY" ]
43074327
topic:
43084328
type: string
43094329
auditTopicsPartitions:

0 commit comments

Comments
 (0)