1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367 |
- openapi: 3.0.0
- info:
- description: Api Documentation
- version: 0.1.0
- title: Api Documentation
- termsOfService: urn:tos
- contact: { }
- license:
- name: Apache 2.0
- url: http://www.apache.org/licenses/LICENSE-2.0
- tags:
- - name: /api/clusters
- - name: /api/clusters/connects
- servers:
- - url: /localhost
- paths:
- /api/clusters:
- get:
- tags:
- - Clusters
- summary: getClusters
- operationId: getClusters
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Cluster'
- /api/clusters/{clusterName}/cache:
- post:
- tags:
- - Clusters
- summary: updateClusterInfo
- operationId: updateClusterInfo
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Cluster'
- 404:
- description: Not found
- /api/clusters/{clusterName}/brokers:
- get:
- tags:
- - Brokers
- summary: getBrokers
- operationId: getBrokers
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Broker'
- /api/clusters/{clusterName}/brokers/{id}/configs:
- get:
- tags:
- - Brokers
- summary: getBrokerConfig
- operationId: getBrokerConfig
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: id
- in: path
- required: true
- schema:
- type: integer
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/BrokerConfig'
- 404:
- description: Not found
- /api/clusters/{clusterName}/brokers/{id}/configs/{name}:
- put:
- tags:
- - Brokers
- summary: updateBrokerConfigByName
- operationId: updateBrokerConfigByName
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: id
- in: path
- required: true
- schema:
- type: integer
- - name: name
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BrokerConfigItem'
- responses:
- 200:
- description: OK
- /api/clusters/{clusterName}/metrics:
- get:
- tags:
- - Clusters
- summary: getClusterMetrics
- operationId: getClusterMetrics
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClusterMetrics'
- /api/clusters/{clusterName}/stats:
- get:
- tags:
- - Clusters
- summary: getClusterStats
- operationId: getClusterStats
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClusterStats'
- /api/clusters/{clusterName}/brokers/{id}/metrics:
- get:
- tags:
- - Brokers
- summary: getBrokersMetrics
- operationId: getBrokersMetrics
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: id
- in: path
- required: true
- schema:
- type: integer
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BrokerMetrics'
- /api/clusters/{clusterName}/brokers/logdirs:
- get:
- tags:
- - Brokers
- summary: getAllBrokersLogdirs
- operationId: getAllBrokersLogdirs
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: broker
- in: query
- description: array of broker ids
- required: false
- schema:
- type: array
- items:
- type: integer
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/BrokersLogdirs'
- /api/clusters/{clusterName}/brokers/{id}/logdirs:
- patch:
- tags:
- - Brokers
- summary: updateBrokerTopicPartitionLogDir
- operationId: updateBrokerTopicPartitionLogDir
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: id
- in: path
- required: true
- schema:
- type: integer
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BrokerLogdirUpdate'
- responses:
- 200:
- description: OK
- /api/clusters/{clusterName}/topics:
- get:
- tags:
- - Topics
- summary: getTopics
- operationId: getTopics
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: page
- in: query
- required: false
- schema:
- type: integer
- - name: perPage
- in: query
- required: false
- schema:
- type: integer
- - name: showInternal
- in: query
- required: false
- schema:
- type: boolean
- - name: search
- in: query
- required: false
- schema:
- type: string
- - name: orderBy
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/TopicColumnsToSort'
- - name: sortOrder
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/SortOrder'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TopicsResponse'
- post:
- tags:
- - Topics
- summary: createTopic
- operationId: createTopic
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TopicCreation'
- responses:
- 201:
- description: Created
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Topic'
- /api/clusters/{clusterName}/topics/{topicName}/clone:
- post:
- tags:
- - Topics
- summary: cloneTopic
- operationId: cloneTopic
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- - name: newTopicName
- in: query
- required: true
- schema:
- type: string
- responses:
- 201:
- description: Created
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Topic'
- 404:
- description: Not found
- /api/clusters/{clusterName}/topics/{topicName}/analysis:
- get:
- tags:
- - Topics
- summary: getTopicAnalysis
- operationId: getTopicAnalysis
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TopicAnalysis'
- 404:
- description: Not found
- post:
- tags:
- - Topics
- summary: analyzeTopic
- operationId: analyzeTopic
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: Analysis started
- 404:
- description: Not found
- delete:
- tags:
- - Topics
- summary: cancelTopicAnalysis
- operationId: cancelTopicAnalysis
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: Analysis cancelled
- 404:
- description: Not found
- /api/clusters/{clusterName}/topics/{topicName}:
- get:
- tags:
- - Topics
- summary: getTopicDetails
- operationId: getTopicDetails
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TopicDetails'
- post:
- tags:
- - Topics
- summary: recreateTopic
- operationId: recreateTopic
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- responses:
- 201:
- description: Created
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Topic'
- 404:
- description: Not found
- 408:
- description: Topic recreation timeout
- patch:
- tags:
- - Topics
- summary: updateTopic
- operationId: updateTopic
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TopicUpdate'
- responses:
- 200:
- description: Updated
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Topic'
- delete:
- tags:
- - Topics
- summary: deleteTopic
- operationId: deleteTopic
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- 404:
- description: Not found
- /api/clusters/{clusterName}/topics/{topicName}/config:
- get:
- tags:
- - Topics
- summary: getTopicConfigs
- operationId: getTopicConfigs
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/TopicConfig'
- /api/clusters/{clusterName}/topics/{topicName}/replications:
- patch:
- tags:
- - Topics
- summary: changeReplicationFactor
- operationId: changeReplicationFactor
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ReplicationFactorChange'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ReplicationFactorChangeResponse'
- 404:
- description: Not found
- 400:
- description: Bad Request
- /api/clusters/{clusterName}/topic/{topicName}/serdes:
- get:
- tags:
- - Messages
- summary: getSerdes
- operationId: getSerdes
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- - name: use
- in: query
- required: true
- schema:
- $ref: '#/components/schemas/SerdeUsage'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TopicSerdeSuggestion'
- /api/clusters/{clusterName}/topics/{topicName}/messages:
- get:
- tags:
- - Messages
- summary: getTopicMessages
- operationId: getTopicMessages
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- - name: seekType
- in: query
- schema:
- $ref: "#/components/schemas/SeekType"
- - name: seekTo
- in: query
- schema:
- type: array
- items:
- type: string
- description: The format is [partition]::[offset] for specifying offsets or [partition]::[timestamp in millis] for specifying timestamps
- - name: limit
- in: query
- schema:
- type: integer
- - name: q
- in: query
- schema:
- type: string
- - name: filterQueryType
- in: query
- schema:
- $ref: "#/components/schemas/MessageFilterType"
- - name: seekDirection
- in: query
- schema:
- $ref: "#/components/schemas/SeekDirection"
- - name: keySerde
- in: query
- description: "Serde that should be used for deserialization. Will be chosen automatically if not set."
- schema:
- type: string
- - name: valueSerde
- in: query
- description: "Serde that should be used for deserialization. Will be chosen automatically if not set."
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- text/event-stream:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/TopicMessageEvent'
- delete:
- tags:
- - Messages
- summary: deleteTopicMessages
- operationId: deleteTopicMessages
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- - name: partitions
- in: query
- required: false
- schema:
- type: array
- items:
- type: integer
- responses:
- 200:
- description: OK
- 404:
- description: Not found
- post:
- tags:
- - Messages
- summary: sendTopicMessages
- operationId: sendTopicMessages
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CreateTopicMessage'
- responses:
- 200:
- description: OK
- 404:
- description: Not found
- /api/clusters/{clusterName}/topics/{topicName}/consumer-groups:
- get:
- tags:
- - Consumer Groups
- summary: get Consumer Groups By Topics
- operationId: getTopicConsumerGroups
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/ConsumerGroup'
- /api/clusters/{clusterName}/consumer-groups/paged:
- get:
- tags:
- - Consumer Groups
- summary: Get consumer croups with paging support
- operationId: getConsumerGroupsPage
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: page
- in: query
- required: false
- schema:
- type: integer
- - name: perPage
- in: query
- required: false
- schema:
- type: integer
- - name: search
- in: query
- required: false
- schema:
- type: string
- - name: orderBy
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/ConsumerGroupOrdering'
- - name: sortOrder
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/SortOrder'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ConsumerGroupsPageResponse'
- /api/clusters/{clusterName}/consumer-groups/{id}:
- get:
- tags:
- - Consumer Groups
- summary: get Consumer Group By Id
- operationId: getConsumerGroup
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: id
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ConsumerGroupDetails'
- delete:
- tags:
- - Consumer Groups
- summary: Delete Consumer Group by ID
- operationId: deleteConsumerGroup
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: id
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- /api/clusters/{clusterName}/consumer-groups:
- get:
- tags:
- - Consumer Groups
- summary: get all ConsumerGroups
- operationId: getConsumerGroups
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/ConsumerGroup'
- /api/clusters/{clusterName}/consumer-groups/{id}/offsets:
- post:
- tags:
- - Consumer Groups
- summary: resets consumer group offsets
- operationId: resetConsumerGroupOffsets
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: id
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ConsumerGroupOffsetsReset'
- responses:
- 200:
- description: OK
- /api/clusters/{clusterName}/schemas:
- post:
- tags:
- - Schemas
- summary: create a new subject schema or update existing subject schema
- operationId: createNewSchema
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/NewSchemaSubject'
- responses:
- 200:
- description: Ok
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SchemaSubject'
- 400:
- description: Bad request
- 409:
- description: Duplicate schema
- 422:
- description: Invalid parameters
- get:
- tags:
- - Schemas
- summary: get all schemas of latest version from Schema Registry service
- operationId: getSchemas
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: page
- in: query
- required: false
- schema:
- type: integer
- - name: perPage
- in: query
- required: false
- schema:
- type: integer
- - name: search
- in: query
- required: false
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SchemaSubjectsResponse'
- /api/clusters/{clusterName}/schemas/{subject}:
- delete:
- tags:
- - Schemas
- summary: delete schema from Schema Registry service
- operationId: deleteSchema
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: subject
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- 404:
- description: Not found
- /api/clusters/{clusterName}/schemas/{subject}/versions:
- get:
- tags:
- - Schemas
- summary: get all version of subject from Schema Registry service
- operationId: getAllVersionsBySubject
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: subject
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/SchemaSubject'
- /api/clusters/{clusterName}/schemas/{subject}/latest:
- get:
- tags:
- - Schemas
- summary: get the latest schema from Schema Registry service
- operationId: getLatestSchema
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: subject
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SchemaSubject'
- delete:
- tags:
- - Schemas
- summary: delete the latest schema from schema registry
- operationId: deleteLatestSchema
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: subject
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- 404:
- description: Not found
- /api/clusters/{clusterName}/schemas/{subject}/versions/{version}:
- get:
- tags:
- - Schemas
- summary: get schema by version from Schema Registry service
- operationId: getSchemaByVersion
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: subject
- in: path
- required: true
- schema:
- type: string
- - name: version
- in: path
- required: true
- schema:
- type: integer
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SchemaSubject'
- delete:
- tags:
- - Schemas
- summary: delete schema by version from schema registry
- operationId: deleteSchemaByVersion
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: subject
- in: path
- required: true
- schema:
- type: string
- - name: version
- in: path
- required: true
- schema:
- type: integer
- responses:
- 200:
- description: OK
- 404:
- description: Not found
- /api/clusters/{clusterName}/schemas/compatibility:
- get:
- tags:
- - Schemas
- summary: Get global schema compatibility level
- operationId: getGlobalSchemaCompatibilityLevel
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CompatibilityLevel'
- put:
- tags:
- - Schemas
- summary: Update compatibility level globally
- operationId: updateGlobalSchemaCompatibilityLevel
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CompatibilityLevel'
- responses:
- 200:
- description: OK
- 404:
- description: Not Found
- /api/clusters/{clusterName}/schemas/{subject}/compatibility:
- put:
- tags:
- - Schemas
- summary: Update compatibility level for specific schema.
- operationId: updateSchemaCompatibilityLevel
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: subject
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CompatibilityLevel'
- responses:
- 200:
- description: OK
- 404:
- description: Not Found
- /api/clusters/{clusterName}/schemas/{subject}/check:
- post:
- tags:
- - Schemas
- summary: Check compatibility of the schema.
- operationId: checkSchemaCompatibility
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: subject
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/NewSchemaSubject'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CompatibilityCheckResponse'
- 404:
- description: Not Found
- /api/clusters/{clusterName}/connects:
- get:
- tags:
- - Kafka Connect
- summary: get all kafka connect instances
- operationId: getConnects
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Connect'
- /api/clusters/{clusterName}/connectors:
- get:
- tags:
- - Kafka Connect
- summary: get filtered kafka connectors
- operationId: getAllConnectors
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: search
- in: query
- required: false
- schema:
- type: string
- - name: orderBy
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/ConnectorColumnsToSort'
- - name: sortOrder
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/SortOrder'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/FullConnectorInfo'
- /api/clusters/{clusterName}/connects/{connectName}/connectors:
- get:
- tags:
- - Kafka Connect
- summary: get connectors for provided kafka connect instance
- operationId: getConnectors
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- type: string
- post:
- tags:
- - Kafka Connect
- summary: create new connector
- operationId: createConnector
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/NewConnector'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Connector'
- 409:
- description: rebalance is in progress
- /api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}:
- get:
- tags:
- - Kafka Connect
- summary: get information about the connector
- operationId: getConnector
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- - name: connectorName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Connector'
- delete:
- tags:
- - Kafka Connect
- summary: delete connector
- operationId: deleteConnector
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- - name: connectorName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- 409:
- description: rebalance is in progress
- /api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/action/{action}:
- post:
- tags:
- - Kafka Connect
- summary: update connector state (restart, pause or resume)
- operationId: updateConnectorState
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- - name: connectorName
- in: path
- required: true
- schema:
- type: string
- - name: action
- in: path
- required: true
- schema:
- $ref: '#/components/schemas/ConnectorAction'
- responses:
- 200:
- description: OK
- 409:
- description: rebalance is in progress
- /api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/config:
- get:
- tags:
- - Kafka Connect
- summary: get connector configuration
- operationId: getConnectorConfig
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- - name: connectorName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ConnectorConfig'
- put:
- tags:
- - Kafka Connect
- summary: update or create connector with provided config
- operationId: setConnectorConfig
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- - name: connectorName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ConnectorConfig'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Connector'
- 409:
- description: rebalance is in progress
- /api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/tasks:
- get:
- tags:
- - Kafka Connect
- summary: get connector tasks
- operationId: getConnectorTasks
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- - name: connectorName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Task'
- /api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/tasks/{taskId}/action/restart:
- post:
- tags:
- - Kafka Connect
- summary: restart connector task
- operationId: restartConnectorTask
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- - name: connectorName
- in: path
- required: true
- schema:
- type: string
- - name: taskId
- in: path
- required: true
- schema:
- type: integer
- responses:
- 200:
- description: OK
- /api/clusters/{clusterName}/ksql:
- description: Deprecated - use ksql/v2 instead!
- post:
- tags:
- - Ksql
- summary: executeKsqlCommand
- operationId: executeKsqlCommand
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/KsqlCommand'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/KsqlCommandResponse'
- /api/clusters/{clusterName}/ksql/v2:
- post:
- tags:
- - Ksql
- summary: executeKsql
- operationId: executeKsql
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/KsqlCommandV2'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/KsqlCommandV2Response'
- /api/clusters/{clusterName}/ksql/tables:
- get:
- tags:
- - Ksql
- summary: listTables
- operationId: listTables
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/KsqlTableDescription'
- /api/clusters/{clusterName}/ksql/streams:
- get:
- tags:
- - Ksql
- summary: listStreams
- operationId: listStreams
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/KsqlStreamDescription'
- /api/clusters/{clusterName}/ksql/response:
- get:
- tags:
- - Ksql
- summary: Open SSE pipe
- operationId: openKsqlResponsePipe
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: pipeId
- in: query
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- text/event-stream:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/KsqlResponse'
- /api/clusters/{clusterName}/connects/{connectName}/plugins:
- get:
- tags:
- - Kafka Connect
- summary: get connector plugins
- operationId: getConnectorPlugins
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/ConnectorPlugin'
- /api/clusters/{clusterName}/connects/{connectName}/plugins/{pluginName}/config/validate:
- put:
- tags:
- - Kafka Connect
- summary: validate connector plugin configuration
- operationId: validateConnectorPluginConfig
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: connectName
- in: path
- required: true
- schema:
- type: string
- - name: pluginName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ConnectorConfig'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ConnectorPluginConfigValidationResponse'
- /api/clusters/{clusterName}/topics/{topicName}/partitions:
- patch:
- tags:
- - Topics
- summary: increaseTopicPartitions
- operationId: increaseTopicPartitions
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- - name: topicName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PartitionsIncrease'
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PartitionsIncreaseResponse'
- 404:
- description: Not found
- /api/clusters/{clusterName}/acls:
- get:
- tags:
- - Acls
- summary: listKafkaAcls
- operationId: listAcls
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/KafkaAcl'
- /api/clusters/{clusterName}/acl/csv:
- get:
- tags:
- - Acls
- summary: getAclAsCsv
- operationId: getAclAsCsv
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- text/plain:
- schema:
- type: string
- post:
- tags:
- - Acls
- summary: syncAclsCsv
- operationId: syncAclsCsv
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- text/plain:
- schema:
- type: string
- responses:
- 200:
- description: OK
- /api/clusters/{clusterName}/acl:
- post:
- tags:
- - Acls
- summary: createAcl
- operationId: createAcl
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/KafkaAcl'
- responses:
- 200:
- description: OK
- delete:
- tags:
- - Acls
- summary: deleteAcl
- operationId: deleteAcl
- parameters:
- - name: clusterName
- in: path
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/KafkaAcl'
- responses:
- 200:
- description: OK
- 404:
- description: Acl not found
- /api/info/timestampformat:
- get:
- tags:
- - TimeStampFormat
- summary: getTimeStampFormat
- operationId: getTimeStampFormat
- responses:
- 200:
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TimeStampFormat'
- components:
- schemas:
- TopicSerdeSuggestion:
- type: object
- properties:
- key:
- type: array
- items:
- $ref: '#/components/schemas/SerdeDescription'
- value:
- type: array
- items:
- $ref: '#/components/schemas/SerdeDescription'
- SerdeDescription:
- type: object
- properties:
- name:
- type: string
- description:
- type: string
- preferred:
- 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."
- type: boolean
- schema:
- type: string
- additionalProperties:
- type: object
- additionalProperties:
- type: object
- SerdeUsage:
- type: string
- enum:
- - SERIALIZE
- - DESERIALIZE
- ErrorResponse:
- description: Error object that will be returned with 4XX and 5XX HTTP statuses
- type: object
- properties:
- code:
- type: integer
- description: Internal error code (can be used for message formatting & localization on UI)
- message:
- type: string
- description: Error message
- timestamp:
- type: number
- description: Response unix timestamp in ms
- requestId:
- type: string
- description: Unique server-defined request id for convenient debugging
- fieldsErrors:
- type: array
- items:
- $ref: '#/components/schemas/FieldError'
- stackTrace:
- type: string
- FieldError:
- type: object
- properties:
- fieldName:
- type: string
- description: Name of field that violated format
- restrictions:
- description: Field format violations description (ex. ["size must be between 0 and 20", "must be a well-formed email address"])
- type: array
- items:
- type: string
- MetricsCollectionError:
- type: object
- properties:
- message:
- type: string
- stackTrace:
- type: string
- Cluster:
- type: object
- properties:
- name:
- type: string
- defaultCluster:
- type: boolean
- status:
- $ref: '#/components/schemas/ServerStatus'
- lastError:
- $ref: '#/components/schemas/MetricsCollectionError'
- brokerCount:
- type: integer
- onlinePartitionCount:
- type: integer
- topicCount:
- type: integer
- bytesInPerSec:
- type: number
- bytesOutPerSec:
- type: number
- readOnly:
- type: boolean
- version:
- type: string
- features:
- type: array
- items:
- type: string
- enum:
- - SCHEMA_REGISTRY
- - KAFKA_CONNECT
- - KSQL_DB
- - TOPIC_DELETION
- - KAFKA_ACL
- required:
- - id
- - name
- - status
- ServerStatus:
- type: string
- enum:
- - online
- - offline
- - initializing
- ClusterMetrics:
- type: object
- properties:
- items:
- type: array
- items:
- $ref: '#/components/schemas/Metric'
- ClusterStats:
- type: object
- properties:
- brokerCount:
- type: integer
- zooKeeperStatus:
- type: integer
- deprecated: true
- activeControllers:
- type: integer
- onlinePartitionCount:
- type: integer
- offlinePartitionCount:
- type: integer
- inSyncReplicasCount:
- type: integer
- outOfSyncReplicasCount:
- type: integer
- underReplicatedPartitionCount:
- type: integer
- diskUsage:
- type: array
- items:
- $ref: '#/components/schemas/BrokerDiskUsage'
- version:
- type: string
- BrokerDiskUsage:
- type: object
- properties:
- brokerId:
- type: integer
- segmentSize:
- type: integer
- format: int64
- segmentCount:
- type: integer
- required:
- - brokerId
- BrokerMetrics:
- type: object
- properties:
- segmentSize:
- type: integer
- format: int64
- segmentCount:
- type: integer
- metrics:
- type: array
- items:
- $ref: '#/components/schemas/Metric'
- BrokerLogdirs:
- type: object
- properties:
- name:
- type: string
- error:
- type: string
- topics:
- type: array
- items:
- $ref: '#/components/schemas/TopicLogdirs'
- BrokersLogdirs:
- type: object
- properties:
- name:
- type: string
- error:
- type: string
- topics:
- type: array
- items:
- $ref: '#/components/schemas/BrokerTopicLogdirs'
- TopicsResponse:
- type: object
- properties:
- pageCount:
- type: integer
- topics:
- type: array
- items:
- $ref: '#/components/schemas/Topic'
- TopicColumnsToSort:
- type: string
- enum:
- - NAME
- - OUT_OF_SYNC_REPLICAS
- - TOTAL_PARTITIONS
- - REPLICATION_FACTOR
- - SIZE
- ConnectorColumnsToSort:
- type: string
- enum:
- - NAME
- - CONNECT
- - TYPE
- - STATUS
- SortOrder:
- type: string
- enum:
- - ASC
- - DESC
- Topic:
- type: object
- properties:
- name:
- type: string
- internal:
- type: boolean
- partitionCount:
- type: integer
- replicationFactor:
- type: integer
- replicas:
- type: integer
- inSyncReplicas:
- type: integer
- segmentSize:
- type: integer
- format: int64
- segmentCount:
- type: integer
- bytesInPerSec:
- type: number
- bytesOutPerSec:
- type: number
- underReplicatedPartitions:
- type: integer
- cleanUpPolicy:
- $ref: '#/components/schemas/CleanUpPolicy'
- partitions:
- type: array
- items:
- $ref: "#/components/schemas/Partition"
- required:
- - name
- TopicAnalysis:
- type: object
- description: "Represents analysis state. Note: 'progress' and 'result' fields are set exclusively depending on analysis state."
- properties:
- progress:
- $ref: '#/components/schemas/TopicAnalysisProgress'
- result:
- $ref: '#/components/schemas/TopicAnalysisResult'
- TopicAnalysisProgress:
- type: object
- properties:
- startedAt:
- type: integer
- format: int64
- completenessPercent:
- type: number
- msgsScanned:
- type: integer
- format: int64
- bytesScanned:
- type: integer
- format: int64
- TopicAnalysisResult:
- type: object
- properties:
- startedAt:
- type: integer
- format: int64
- finishedAt:
- type: integer
- format: int64
- error:
- type: string
- totalStats:
- $ref: '#/components/schemas/TopicAnalysisStats'
- partitionStats:
- type: array
- items:
- $ref: "#/components/schemas/TopicAnalysisStats"
- TopicAnalysisStats:
- type: object
- properties:
- partition:
- type: integer
- format: int32
- description: "null if this is total stats"
- totalMsgs:
- type: integer
- format: int64
- minOffset:
- type: integer
- format: int64
- maxOffset:
- type: integer
- format: int64
- minTimestamp:
- type: integer
- format: int64
- maxTimestamp:
- type: integer
- format: int64
- nullKeys:
- type: integer
- format: int64
- nullValues:
- type: integer
- format: int64
- approxUniqKeys:
- type: integer
- format: int64
- approxUniqValues:
- type: integer
- format: int64
- keySize:
- $ref: "#/components/schemas/TopicAnalysisSizeStats"
- valueSize:
- $ref: "#/components/schemas/TopicAnalysisSizeStats"
- hourlyMsgCounts:
- type: array
- items:
- type: object
- properties:
- hourStart:
- type: integer
- format: int64
- count:
- type: integer
- format: int64
- TopicAnalysisSizeStats:
- type: object
- description: "All sizes in bytes"
- properties:
- sum:
- type: integer
- format: int64
- min:
- type: integer
- format: int64
- max:
- type: integer
- format: int64
- avg:
- type: integer
- format: int64
- prctl50:
- type: integer
- format: int64
- prctl75:
- type: integer
- format: int64
- prctl95:
- type: integer
- format: int64
- prctl99:
- type: integer
- format: int64
- prctl999:
- type: integer
- format: int64
- Replica:
- type: object
- properties:
- broker:
- type: integer
- leader:
- type: boolean
- inSync:
- type: boolean
- TopicDetails:
- type: object
- properties:
- name:
- type: string
- internal:
- type: boolean
- partitions:
- type: array
- items:
- $ref: "#/components/schemas/Partition"
- partitionCount:
- type: integer
- replicationFactor:
- type: integer
- replicas:
- type: integer
- inSyncReplicas:
- type: integer
- bytesInPerSec:
- type: number
- bytesOutPerSec:
- type: number
- segmentSize:
- type: integer
- format: int64
- segmentCount:
- type: integer
- underReplicatedPartitions:
- type: integer
- cleanUpPolicy:
- $ref: '#/components/schemas/CleanUpPolicy'
- keySerde:
- type: string
- valueSerde:
- type: string
- required:
- - name
- TopicConfig:
- type: object
- properties:
- name:
- type: string
- value:
- type: string
- defaultValue:
- type: string
- source:
- $ref: "#/components/schemas/ConfigSource"
- isSensitive:
- type: boolean
- isReadOnly:
- type: boolean
- synonyms:
- type: array
- items:
- $ref: "#/components/schemas/ConfigSynonym"
- doc:
- type: string
- required:
- - name
- TopicCreation:
- type: object
- properties:
- name:
- type: string
- partitions:
- type: integer
- replicationFactor:
- type: integer
- configs:
- type: object
- additionalProperties:
- type: string
- required:
- - name
- - partitions
- TopicUpdate:
- type: object
- properties:
- configs:
- type: object
- additionalProperties:
- type: string
- required:
- - configs
- Broker:
- type: object
- properties:
- id:
- type: integer
- host:
- type: string
- port:
- type: integer
- required:
- - id
- BrokerLogdirUpdate:
- type: object
- properties:
- topic:
- type: string
- partition:
- type: integer
- logDir:
- type: string
- ConsumerGroupState:
- type: string
- enum:
- - UNKNOWN
- - PREPARING_REBALANCE
- - COMPLETING_REBALANCE
- - STABLE
- - DEAD
- - EMPTY
- MessageFormat:
- type: string
- enum:
- - AVRO
- - JSON
- - PROTOBUF
- - UNKNOWN
- ConsumerGroup:
- type: object
- properties:
- groupId:
- type: string
- members:
- type: integer
- topics:
- type: integer
- simple:
- type: boolean
- partitionAssignor:
- type: string
- state:
- $ref: "#/components/schemas/ConsumerGroupState"
- coordinator:
- $ref: "#/components/schemas/Broker"
- messagesBehind:
- type: integer
- format: int64
- description: null if consumer group has no offsets committed
- required:
- - groupId
- ConsumerGroupOrdering:
- type: string
- enum:
- - NAME
- - MEMBERS
- - STATE
- ConsumerGroupsPageResponse:
- type: object
- properties:
- pageCount:
- type: integer
- consumerGroups:
- type: array
- items:
- $ref: '#/components/schemas/ConsumerGroup'
- CreateTopicMessage:
- type: object
- properties:
- partition:
- type: integer
- key:
- type: string
- nullable: true
- headers:
- type: object
- additionalProperties:
- type: string
- content:
- type: string
- nullable: true
- keySerde:
- type: string
- nullable: true
- valueSerde:
- type: string
- nullable: true
- required:
- - partition
- TopicMessageEvent:
- type: object
- properties:
- type:
- type: string
- enum:
- - PHASE
- - MESSAGE
- - CONSUMING
- - DONE
- - EMIT_THROTTLING
- message:
- $ref: "#/components/schemas/TopicMessage"
- phase:
- $ref: "#/components/schemas/TopicMessagePhase"
- consuming:
- $ref: "#/components/schemas/TopicMessageConsuming"
- TopicMessagePhase:
- type: object
- properties:
- name:
- type: string
- TimeStampFormat:
- type: object
- properties:
- timeStampFormat:
- type: string
- TopicMessageConsuming:
- type: object
- properties:
- bytesConsumed:
- type: integer
- format: int64
- elapsedMs:
- type: integer
- format: int64
- isCancelled:
- type: boolean
- messagesConsumed:
- type: integer
- TopicMessage:
- type: object
- properties:
- partition:
- type: integer
- offset:
- type: integer
- format: int64
- timestamp:
- type: string
- format: date-time
- timestampType:
- type: string
- enum:
- - NO_TIMESTAMP_TYPE
- - CREATE_TIME
- - LOG_APPEND_TIME
- key:
- type: string
- headers:
- type: object
- additionalProperties:
- type: string
- content:
- type: string
- keyFormat:
- #deprecated - wont be filled - use 'keySerde' field instead
- $ref: "#/components/schemas/MessageFormat"
- valueFormat:
- #deprecated - wont be filled - use 'valueSerde' field instead
- $ref: "#/components/schemas/MessageFormat"
- keySize:
- type: integer
- format: int64
- valueSize:
- type: integer
- format: int64
- keySchemaId:
- deprecated: true
- description: deprecated - wont be filled - use 'keyDeserializeProperties' field instead
- type: string
- valueSchemaId:
- deprecated: true
- description: deprecated - wont be filled - use 'valueDeserializeProperties' field instead
- type: string
- headersSize:
- type: integer
- format: int64
- keySerde:
- type: string
- valueSerde:
- type: string
- keyDeserializeProperties:
- additionalProperties:
- type: object
- valueDeserializeProperties:
- additionalProperties:
- type: object
- required:
- - partition
- - offset
- - timestamp
- SeekType:
- type: string
- enum:
- - BEGINNING
- - OFFSET
- - TIMESTAMP
- - LATEST
- MessageFilterType:
- type: string
- enum:
- - STRING_CONTAINS
- - GROOVY_SCRIPT
- SeekDirection:
- type: string
- enum:
- - FORWARD
- - BACKWARD
- - TAILING
- default: FORWARD
- Partition:
- type: object
- properties:
- partition:
- type: integer
- leader:
- type: integer
- replicas:
- type: array
- items:
- $ref: '#/components/schemas/Replica'
- offsetMax:
- type: integer
- format: int64
- offsetMin:
- type: integer
- format: int64
- required:
- - topic
- - partition
- - offsetMax
- - offsetMin
- ConsumerGroupTopicPartition:
- type: object
- properties:
- topic:
- type: string
- partition:
- type: integer
- currentOffset:
- type: integer
- format: int64
- endOffset:
- type: integer
- format: int64
- messagesBehind:
- type: integer
- format: int64
- description: null if consumer group has no offsets committed
- consumerId:
- type: string
- host:
- type: string
- required:
- - topic
- - partition
- ConsumerGroupDetails:
- allOf:
- - $ref: '#/components/schemas/ConsumerGroup'
- - type: object
- properties:
- partitions:
- type: array
- items:
- $ref: '#/components/schemas/ConsumerGroupTopicPartition'
- Metric:
- type: object
- properties:
- name:
- type: string
- labels:
- type: string
- additionalProperties:
- type: string
- value:
- type: number
- TopicLogdirs:
- type: object
- properties:
- name:
- type: string
- partitions:
- type: array
- items:
- $ref: '#/components/schemas/TopicPartitionLogdir'
- BrokerTopicLogdirs:
- type: object
- properties:
- name:
- type: string
- partitions:
- type: array
- items:
- $ref: '#/components/schemas/BrokerTopicPartitionLogdir'
- TopicPartitionLogdir:
- type: object
- properties:
- partition:
- type: integer
- size:
- type: integer
- format: int64
- offsetLag:
- type: integer
- format: int64
- BrokerTopicPartitionLogdir:
- allOf:
- - $ref: '#/components/schemas/TopicPartitionLogdir'
- - type: object
- properties:
- broker:
- type: integer
- SchemaSubject:
- type: object
- properties:
- subject:
- type: string
- version:
- type: string
- id:
- type: integer
- schema:
- type: string
- compatibilityLevel:
- type: string
- schemaType:
- $ref: '#/components/schemas/SchemaType'
- required:
- - id
- - subject
- - version
- - schema
- - compatibilityLevel
- - schemaType
- NewSchemaSubject:
- type: object
- description: should be set for creating/updating schema subject
- properties:
- subject:
- type: string
- schema:
- type: string
- schemaType:
- $ref: '#/components/schemas/SchemaType'
- description: upon updating a schema, the type of an existing schema can't be changed
- required:
- - subject
- - schema
- - schemaType
- CompatibilityLevel:
- type: object
- properties:
- compatibility:
- type: string
- enum:
- - BACKWARD
- - BACKWARD_TRANSITIVE
- - FORWARD
- - FORWARD_TRANSITIVE
- - FULL
- - FULL_TRANSITIVE
- - NONE
- required:
- - compatibility
- SchemaType:
- type: string
- description: upon updating a schema, the type of an existing schema can't be changed
- enum:
- - AVRO
- - JSON
- - PROTOBUF
- CompatibilityCheckResponse:
- type: object
- properties:
- isCompatible:
- type: boolean
- required:
- - isCompatible
- SchemaSubjectsResponse:
- type: object
- properties:
- pageCount:
- type: integer
- schemas:
- type: array
- items:
- $ref: '#/components/schemas/SchemaSubject'
- Connect:
- type: object
- properties:
- name:
- type: string
- address:
- type: string
- required:
- - name
- ConnectorConfig:
- type: object
- additionalProperties:
- type: object
- TaskId:
- type: object
- properties:
- connector:
- type: string
- task:
- type: integer
- Task:
- type: object
- properties:
- id:
- $ref: '#/components/schemas/TaskId'
- status:
- $ref: '#/components/schemas/TaskStatus'
- config:
- $ref: '#/components/schemas/ConnectorConfig'
- required:
- - status
- NewConnector:
- type: object
- properties:
- name:
- type: string
- config:
- $ref: '#/components/schemas/ConnectorConfig'
- required:
- - name
- - config
- Connector:
- allOf:
- - $ref: '#/components/schemas/NewConnector'
- - type: object
- properties:
- tasks:
- type: array
- items:
- $ref: '#/components/schemas/TaskId'
- type:
- $ref: '#/components/schemas/ConnectorType'
- status:
- $ref: '#/components/schemas/ConnectorStatus'
- connect:
- type: string
- required:
- - type
- - status
- - connect
- ConnectorType:
- type: string
- enum:
- - SOURCE
- - SINK
- ConsumerGroupOffsetsReset:
- type: object
- properties:
- topic:
- type: string
- resetType:
- $ref: '#/components/schemas/ConsumerGroupOffsetsResetType'
- partitions:
- type: array
- items:
- type: integer
- description: list of target partitions, all partitions will be used if it is not set or empty
- resetToTimestamp:
- type: integer
- format: int64
- description: should be set if resetType is TIMESTAMP
- partitionsOffsets:
- type: array
- items:
- $ref: '#/components/schemas/PartitionOffset'
- description: List of partition offsets to reset to, should be set when resetType is OFFSET
- required:
- - topic
- - resetType
- PartitionOffset:
- type: object
- properties:
- partition:
- type: integer
- offset:
- type: integer
- format: int64
- required:
- - partition
- ConsumerGroupOffsetsResetType:
- type: string
- enum:
- - EARLIEST
- - LATEST
- - TIMESTAMP
- - OFFSET
- TaskStatus:
- type: object
- properties:
- id:
- type: integer
- state:
- $ref: '#/components/schemas/ConnectorTaskStatus'
- worker_id:
- type: string
- trace:
- type: string
- required:
- - id
- - state
- - worker_id
- ConnectorStatus:
- type: object
- properties:
- state:
- $ref: '#/components/schemas/ConnectorState'
- worker_id:
- type: string
- required:
- - state
- ConnectorTaskStatus:
- type: string
- enum:
- - RUNNING
- - FAILED
- - PAUSED
- - RESTARTING
- - UNASSIGNED
- ConnectorState:
- type: string
- enum:
- - RUNNING
- - FAILED
- - PAUSED
- - UNASSIGNED
- - TASK_FAILED
- ConnectorAction:
- type: string
- enum:
- - RESTART
- - RESTART_ALL_TASKS
- - RESTART_FAILED_TASKS
- - PAUSE
- - RESUME
- TaskAction:
- type: string
- enum:
- - restart
- ConnectorPlugin:
- type: object
- properties:
- class:
- type: string
- ConnectorPluginConfigDefinition:
- type: object
- properties:
- name:
- type: string
- type:
- type: string
- enum:
- - BOOLEAN
- - CLASS
- - DOUBLE
- - INT
- - LIST
- - LONG
- - PASSWORD
- - SHORT
- - STRING
- required:
- type: boolean
- default_value:
- type: string
- importance:
- type: string
- enum:
- - LOW
- - MEDIUM
- - HIGH
- documentation:
- type: string
- group:
- type: string
- width:
- type: string
- enum:
- - SHORT
- - MEDIUM
- - LONG
- - NONE
- display_name:
- type: string
- dependents:
- type: array
- items:
- type: string
- order:
- type: integer
- ConnectorPluginConfigValue:
- type: object
- properties:
- name:
- type: string
- value:
- type: string
- recommended_values:
- type: array
- items:
- type: string
- errors:
- type: array
- items:
- type: string
- visible:
- type: boolean
- ConnectorPluginConfig:
- type: object
- properties:
- definition:
- $ref: '#/components/schemas/ConnectorPluginConfigDefinition'
- value:
- $ref: '#/components/schemas/ConnectorPluginConfigValue'
- ConnectorPluginConfigValidationResponse:
- type: object
- properties:
- name:
- type: string
- error_count:
- type: integer
- groups:
- type: array
- items:
- type: string
- configs:
- type: array
- items:
- $ref: '#/components/schemas/ConnectorPluginConfig'
- KsqlCommand:
- type: object
- properties:
- ksql:
- type: string
- streamsProperties:
- type: object
- additionalProperties:
- type: string
- required:
- - ksql
- KsqlCommandV2:
- type: object
- properties:
- ksql:
- type: string
- streamsProperties:
- type: object
- additionalProperties:
- type: string
- required:
- - ksql
- KsqlCommandV2Response:
- type: object
- properties:
- pipeId:
- type: string
- required:
- - pipeId
- KsqlTableDescription:
- type: object
- properties:
- name:
- type: string
- topic:
- type: string
- keyFormat:
- type: string
- valueFormat:
- type: string
- isWindowed:
- type: boolean
- KsqlStreamDescription:
- type: object
- properties:
- name:
- type: string
- topic:
- type: string
- keyFormat:
- type: string
- valueFormat:
- type: string
- KsqlCommandResponse:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Table'
- message:
- type: string
- Table:
- type: object
- properties:
- headers:
- type: array
- items:
- type: string
- rows:
- type: array
- items:
- type: array
- items:
- type: string
- required:
- - headers
- - rows
- KsqlResponse:
- type: object
- properties:
- table:
- $ref: '#/components/schemas/KsqlTableResponse'
- KsqlTableResponse:
- type: object
- properties:
- header:
- type: string
- columnNames:
- type: array
- items:
- type: string
- values:
- type: array
- items:
- type: array
- items:
- type: object
- FullConnectorInfo:
- type: object
- properties:
- connect:
- type: string
- name:
- type: string
- connector_class:
- type: string
- type:
- $ref: '#/components/schemas/ConnectorType'
- topics:
- type: array
- items:
- type: string
- status:
- $ref: '#/components/schemas/ConnectorStatus'
- tasks_count:
- type: integer
- failed_tasks_count:
- type: integer
- required:
- - name
- - connect
- - status
- PartitionsIncrease:
- type: object
- properties:
- totalPartitionsCount:
- type: integer
- minimum: 1
- required:
- - totalPartitionsCount
- PartitionsIncreaseResponse:
- type: object
- properties:
- totalPartitionsCount:
- type: integer
- topicName:
- type: string
- required:
- - totalPartitionsCount
- - topicName
- ReplicationFactorChange:
- type: object
- properties:
- totalReplicationFactor:
- type: integer
- required:
- - totalReplicationFactor
- ReplicationFactorChangeResponse:
- type: object
- properties:
- totalReplicationFactor:
- type: integer
- topicName:
- type: string
- required:
- - totalReplicationFactor
- - topicName
- BrokerConfigItem:
- type: object
- properties:
- value:
- type: string
- BrokerConfig:
- type: object
- properties:
- name:
- type: string
- value:
- type: string
- source:
- $ref: '#/components/schemas/ConfigSource'
- isSensitive:
- type: boolean
- isReadOnly:
- type: boolean
- synonyms:
- type: array
- items:
- $ref: '#/components/schemas/ConfigSynonym'
- required:
- - name
- - value
- - source
- - isSensitive
- - isReadOnly
- ConfigSource:
- type: string
- enum:
- - DYNAMIC_TOPIC_CONFIG
- - DYNAMIC_BROKER_LOGGER_CONFIG
- - DYNAMIC_BROKER_CONFIG
- - DYNAMIC_DEFAULT_BROKER_CONFIG
- - STATIC_BROKER_CONFIG
- - DEFAULT_CONFIG
- - UNKNOWN
- ConfigSynonym:
- type: object
- properties:
- name:
- type: string
- value:
- type: string
- source:
- $ref: '#/components/schemas/ConfigSource'
- CleanUpPolicy:
- type: string
- enum:
- - DELETE
- - COMPACT
- - COMPACT_DELETE
- - UNKNOWN
- KafkaAcl:
- type: object
- required: [resourceType, resourceName, namePatternType, principal, host, operation, permission]
- properties:
- resourceType:
- type: string
- enum:
- - TOPIC
- - GROUP
- - CLUSTER
- - TRANSACTIONAL_ID
- - DELEGATION_TOPIC
- resourceName:
- type: string # "*" if acl can be applied to any resource of given type
- namePatternType:
- type: string
- enum:
- - LITERAL
- - PREFIXED
- principal:
- type: string
- host:
- type: string # "*" if acl can be applied to any resource of given type
- operation:
- type: string
- enum:
- - ALL # Cluster, Topic, Group
- - READ # Topic, Group
- - WRITE # Topic, TransactionalId
- - CREATE # Cluster, Topic
- - DELETE # Topic, Group
- - ALTER # Cluster, Topic,
- - DESCRIBE # Cluster, Topic, Group, TransactionalId, DelegationToken
- - CLUSTER_ACTION # Cluster
- - DESCRIBE_CONFIGS # Cluster, Topic
- - ALTER_CONFIGS # Cluster, Topic
- - IDEMPOTENT_WRITE # -
- permission:
- type: string
- enum:
- - ALLOW
- - DENY
|