Skip to content

Commit 71a163d

Browse files
app-services-ciapp-services-ci
authored
chore(all): re-generate OpenAPI client(s) (#236)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 42d30b7 commit 71a163d

15 files changed

Lines changed: 1289 additions & 20 deletions

File tree

‎packages/connector-management-sdk/pom.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@
137137
<plugin>
138138
<groupId>org.apache.maven.plugins</groupId>
139139
<artifactId>maven-compiler-plugin</artifactId>
140-
<version>3.10.1</version>
140+
<version>3.9.0</version>
141141
<configuration>
142142
<source>1.8</source>
143143
<target>1.8</target>
@@ -146,7 +146,7 @@
146146
<plugin>
147147
<groupId>org.apache.maven.plugins</groupId>
148148
<artifactId>maven-javadoc-plugin</artifactId>
149-
<version>3.3.2</version>
149+
<version>3.3.1</version>
150150
<configuration>
151151
<doclint>none</doclint>
152152
<source>1.8</source>
@@ -175,7 +175,7 @@
175175
<plugin>
176176
<groupId>org.sonatype.plugins</groupId>
177177
<artifactId>nexus-staging-maven-plugin</artifactId>
178-
<version>1.6.12</version>
178+
<version>1.6.8</version>
179179
<extensions>true</extensions>
180180
<configuration>
181181
<serverId>ossrh</serverId>

‎packages/kafka-instance-sdk/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ Class | Method | HTTP request | Description
124124
*GroupsApi* | [**getConsumerGroupById**](docs/GroupsApi.md#getConsumerGroupById) | **GET** /rest/consumer-groups/{consumerGroupId} | Get a single consumer group by its unique ID.
125125
*GroupsApi* | [**getConsumerGroups**](docs/GroupsApi.md#getConsumerGroups) | **GET** /rest/consumer-groups | List of consumer groups in the Kafka instance.
126126
*GroupsApi* | [**resetConsumerGroupOffset**](docs/GroupsApi.md#resetConsumerGroupOffset) | **POST** /rest/consumer-groups/{consumerGroupId}/reset-offset | Reset the offset for a consumer group.
127+
*RecordsApi* | [**consumeRecords**](docs/RecordsApi.md#consumeRecords) | **GET** /rest/topics/{topicName}/records | Consume records from a topic
128+
*RecordsApi* | [**produceRecord**](docs/RecordsApi.md#produceRecord) | **POST** /rest/topics/{topicName}/records | Send a record to a topic
127129
*TopicsApi* | [**createTopic**](docs/TopicsApi.md#createTopic) | **POST** /rest/topics | Creates a new topic
128130
*TopicsApi* | [**deleteTopic**](docs/TopicsApi.md#deleteTopic) | **DELETE** /rest/topics/{topicName} | Deletes a topic
129131
*TopicsApi* | [**getTopic**](docs/TopicsApi.md#getTopic) | **GET** /rest/topics/{topicName} | Retrieves a single topic
@@ -160,6 +162,9 @@ Class | Method | HTTP request | Description
160162
- [Node](docs/Node.md)
161163
- [OffsetType](docs/OffsetType.md)
162164
- [Partition](docs/Partition.md)
165+
- [Record](docs/Record.md)
166+
- [RecordIncludedProperty](docs/RecordIncludedProperty.md)
167+
- [RecordList](docs/RecordList.md)
163168
- [SortDirection](docs/SortDirection.md)
164169
- [Topic](docs/Topic.md)
165170
- [TopicOrderKey](docs/TopicOrderKey.md)

‎packages/kafka-instance-sdk/api/openapi.yaml‎

Lines changed: 299 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ tags:
1818
name: groups
1919
- description: Access Control Management (ACLs)
2020
name: acls
21+
- description: Send and receive records interactively
22+
name: records
2123
paths:
2224
/rest/topics:
2325
get:
@@ -1180,6 +1182,190 @@ paths:
11801182
tags:
11811183
- acls
11821184
x-accepts: application/json
1185+
/rest/topics/{topicName}/records:
1186+
get:
1187+
description: Consume a limited number of records from a topic, optionally specifying
1188+
a partition and an absolute offset or timestamp as the starting point for
1189+
message retrieval.
1190+
operationId: consumeRecords
1191+
parameters:
1192+
- description: Topic name
1193+
explode: false
1194+
in: path
1195+
name: topicName
1196+
required: true
1197+
schema:
1198+
type: string
1199+
style: simple
1200+
- description: List of properties to include for each record in the response
1201+
explode: false
1202+
in: query
1203+
name: include
1204+
required: false
1205+
schema:
1206+
items:
1207+
$ref: '#/components/schemas/RecordIncludedProperty'
1208+
type: array
1209+
style: form
1210+
- description: Limit the number of records fetched and returned
1211+
explode: true
1212+
in: query
1213+
name: limit
1214+
required: false
1215+
schema:
1216+
format: int32
1217+
type: integer
1218+
style: form
1219+
- description: Retrieve messages with an offset equal to or greater than this
1220+
offset. If both `timestamp` and `offset` are requested, `timestamp` is given
1221+
preference.
1222+
explode: true
1223+
in: query
1224+
name: offset
1225+
required: false
1226+
schema:
1227+
format: int32
1228+
type: integer
1229+
style: form
1230+
- description: Retrieve messages only from this partition
1231+
explode: true
1232+
in: query
1233+
name: partition
1234+
required: false
1235+
schema:
1236+
format: int32
1237+
type: integer
1238+
style: form
1239+
- description: Retrieve messages with a timestamp equal to or later than this
1240+
timestamp. If both `timestamp` and `offset` are requested, `timestamp` is
1241+
given preference.
1242+
explode: true
1243+
in: query
1244+
name: timestamp
1245+
required: false
1246+
schema:
1247+
format: date-time
1248+
style: form
1249+
responses:
1250+
"400":
1251+
content:
1252+
application/json:
1253+
examples:
1254+
badrequest:
1255+
summary: Invalid query parameter
1256+
value:
1257+
code: 400
1258+
error_message: Invalid parameter value
1259+
schema:
1260+
$ref: '#/components/schemas/Error'
1261+
description: |-
1262+
The client request was invalid. One or more request parameters or the request
1263+
body was rejected. Additional information may be found in the response.
1264+
"401":
1265+
content:
1266+
application/json:
1267+
schema:
1268+
$ref: '#/components/schemas/Error'
1269+
description: Request authentication missing or invalid
1270+
"403":
1271+
content:
1272+
application/json:
1273+
schema:
1274+
$ref: '#/components/schemas/Error'
1275+
description: User is not authorized to access requested resource
1276+
"500":
1277+
content:
1278+
application/json:
1279+
schema:
1280+
$ref: '#/components/schemas/Error'
1281+
description: Internal server error
1282+
"503":
1283+
content:
1284+
application/json:
1285+
schema:
1286+
$ref: '#/components/schemas/Error'
1287+
description: Kafka service unavailable
1288+
"200":
1289+
content:
1290+
application/json:
1291+
schema:
1292+
$ref: '#/components/schemas/RecordList'
1293+
description: List of records matching the request query parameters.
1294+
summary: Consume records from a topic
1295+
tags:
1296+
- records
1297+
x-accepts: application/json
1298+
post:
1299+
description: Produce (write) a single record to a topic.
1300+
operationId: produceRecord
1301+
parameters:
1302+
- description: Topic name
1303+
explode: false
1304+
in: path
1305+
name: topicName
1306+
required: true
1307+
schema:
1308+
type: string
1309+
style: simple
1310+
requestBody:
1311+
content:
1312+
application/json:
1313+
examples:
1314+
RecordProduceExample:
1315+
$ref: '#/components/examples/RecordProduceExample'
1316+
schema:
1317+
$ref: '#/components/schemas/Record'
1318+
required: true
1319+
responses:
1320+
"400":
1321+
content:
1322+
application/json:
1323+
examples:
1324+
badrequest:
1325+
summary: Invalid query parameter
1326+
value:
1327+
code: 400
1328+
error_message: Invalid parameter value
1329+
schema:
1330+
$ref: '#/components/schemas/Error'
1331+
description: |-
1332+
The client request was invalid. One or more request parameters or the request
1333+
body was rejected. Additional information may be found in the response.
1334+
"401":
1335+
content:
1336+
application/json:
1337+
schema:
1338+
$ref: '#/components/schemas/Error'
1339+
description: Request authentication missing or invalid
1340+
"403":
1341+
content:
1342+
application/json:
1343+
schema:
1344+
$ref: '#/components/schemas/Error'
1345+
description: User is not authorized to access requested resource
1346+
"500":
1347+
content:
1348+
application/json:
1349+
schema:
1350+
$ref: '#/components/schemas/Error'
1351+
description: Internal server error
1352+
"503":
1353+
content:
1354+
application/json:
1355+
schema:
1356+
$ref: '#/components/schemas/Error'
1357+
description: Kafka service unavailable
1358+
"201":
1359+
content:
1360+
application/json:
1361+
schema:
1362+
$ref: '#/components/schemas/Record'
1363+
description: Record was successfully sent to the topic
1364+
summary: Send a record to a topic
1365+
tags:
1366+
- records
1367+
x-contentType: application/json
1368+
x-accepts: application/json
11831369
components:
11841370
examples:
11851371
NewTopicExample:
@@ -1234,6 +1420,14 @@ components:
12341420
- topic: my-topic
12351421
partitions:
12361422
- 0
1423+
RecordProduceExample:
1424+
description: Sample record to produce a record to partition 1, including a custom
1425+
header
1426+
value:
1427+
partition: 1
1428+
headers:
1429+
X-Custom-Header: header-value-1
1430+
value: '{ "examplekey": "example-value" }'
12371431
responses:
12381432
BadRequest:
12391433
content:
@@ -1828,6 +2022,111 @@ components:
18282022
required:
18292023
- partition
18302024
type: object
2025+
Record:
2026+
description: An individual record consumed from a topic or produced to a topic
2027+
example:
2028+
headers:
2029+
key: headers
2030+
partition: 5
2031+
offset: 5
2032+
timestampType: timestampType
2033+
value: value
2034+
key: key
2035+
timestamp: 2000-01-23T04:56:07.000+00:00
2036+
properties:
2037+
partition:
2038+
description: The record's partition within the topic
2039+
format: int32
2040+
type: integer
2041+
offset:
2042+
description: The record's offset within the topic partition
2043+
format: int64
2044+
readOnly: true
2045+
type: integer
2046+
timestamp:
2047+
description: Timestamp associated with the record. The type is indicated
2048+
by `timestampType`. When producing a record, this value will be used as
2049+
the record's `CREATE_TIME`.
2050+
format: date-time
2051+
type: string
2052+
timestampType:
2053+
description: Type of timestamp associated with the record
2054+
readOnly: true
2055+
type: string
2056+
headers:
2057+
additionalProperties:
2058+
type: string
2059+
description: Record headers, key/value pairs
2060+
type: object
2061+
key:
2062+
description: Record key
2063+
type: string
2064+
value:
2065+
description: Record value
2066+
nullable: false
2067+
type: string
2068+
required:
2069+
- value
2070+
title: Record
2071+
type: object
2072+
RecordIncludedProperty:
2073+
enum:
2074+
- partition
2075+
- offset
2076+
- timestamp
2077+
- timestampType
2078+
- headers
2079+
- key
2080+
- value
2081+
type: string
2082+
RecordList:
2083+
description: A page of records consumed from a topic
2084+
example:
2085+
total: 0
2086+
size: 6
2087+
page: 1
2088+
items:
2089+
- headers:
2090+
key: headers
2091+
partition: 5
2092+
offset: 5
2093+
timestampType: timestampType
2094+
value: value
2095+
key: key
2096+
timestamp: 2000-01-23T04:56:07.000+00:00
2097+
- headers:
2098+
key: headers
2099+
partition: 5
2100+
offset: 5
2101+
timestampType: timestampType
2102+
value: value
2103+
key: key
2104+
timestamp: 2000-01-23T04:56:07.000+00:00
2105+
properties:
2106+
total:
2107+
description: Total number of records returned in this request. This value
2108+
does not indicate the total number of records in the topic.
2109+
format: int32
2110+
nullable: false
2111+
type: integer
2112+
size:
2113+
description: Not used
2114+
format: int32
2115+
type: integer
2116+
page:
2117+
description: Not used
2118+
format: int32
2119+
type: integer
2120+
items:
2121+
items:
2122+
$ref: '#/components/schemas/Record'
2123+
nullable: false
2124+
type: array
2125+
required:
2126+
- items
2127+
- total
2128+
title: Record List
2129+
type: object
18312130
SortDirection:
18322131
enum:
18332132
- asc

‎packages/kafka-instance-sdk/docs/Record.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
3+
# Record
4+
5+
An individual record consumed from a topic or produced to a topic
6+
7+
## Properties
8+
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**partition** | **Integer** | The record&#39;s partition within the topic | [optional]
12+
**offset** | **Long** | The record&#39;s offset within the topic partition | [optional] [readonly]
13+
**timestamp** | **OffsetDateTime** | Timestamp associated with the record. The type is indicated by &#x60;timestampType&#x60;. When producing a record, this value will be used as the record&#39;s &#x60;CREATE_TIME&#x60;. | [optional]
14+
**timestampType** | **String** | Type of timestamp associated with the record | [optional] [readonly]
15+
**headers** | **Map&lt;String, String&gt;** | Record headers, key/value pairs | [optional]
16+
**key** | **String** | Record key | [optional]
17+
**value** | **String** | Record value |
18+
19+
20+

0 commit comments

Comments
 (0)