Skip to content

Commit 0eee56d

Browse files
chore(openapi): update connector-mgmt/v1 OpenAPI document (#600)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 249de1e commit 0eee56d

1 file changed

Lines changed: 22 additions & 7 deletions

File tree

.openapi/connector_mgmt.yaml

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1160,6 +1160,12 @@ components:
11601160
# Connector Cluster
11611161
#
11621162

1163+
ConnectorResourceAnnotations:
1164+
description: Name-value string annotations for resource
1165+
type: object
1166+
additionalProperties:
1167+
type: "string"
1168+
11631169
ConnectorClusterState:
11641170
type: string
11651171
enum:
@@ -1168,9 +1174,12 @@ components:
11681174
- deleting
11691175

11701176
ConnectorClusterRequestMeta:
1177+
type: object
11711178
properties:
11721179
name:
11731180
type: string
1181+
annotations:
1182+
$ref: "#/components/schemas/ConnectorResourceAnnotations"
11741183

11751184
ConnectorClusterRequest:
11761185
description: "Schema for the request to update a data plane cluster's name"
@@ -1259,6 +1268,7 @@ components:
12591268
type: object
12601269

12611270
ConnectorRequestMeta:
1271+
type: object
12621272
required:
12631273
- name
12641274
- connector_type_id
@@ -1275,6 +1285,9 @@ components:
12751285
$ref: "#/components/schemas/Channel"
12761286
desired_state:
12771287
$ref: "#/components/schemas/ConnectorDesiredState"
1288+
annotations:
1289+
$ref: "#/components/schemas/ConnectorResourceAnnotations"
1290+
12781291

12791292
ConnectorRequest:
12801293
allOf:
@@ -1353,12 +1366,14 @@ components:
13531366
type: array
13541367
items:
13551368
type: string
1369+
annotations:
1370+
$ref: "#/components/schemas/ConnectorResourceAnnotations"
13561371
featured_rank:
13571372
description: Ranking for featured connectors
13581373
type: integer
13591374
format: int32
13601375
capabilities:
1361-
description: The capabilities supported by the conenctor
1376+
description: The capabilities supported by the connector
13621377
type: array
13631378
items:
13641379
type: string
@@ -1412,9 +1427,7 @@ components:
14121427
pattern: "^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"
14131428
description: Namespace name must match pattern `^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$`, or it may be empty to be auto-generated.
14141429
annotations:
1415-
type: object
1416-
additionalProperties:
1417-
type: "string"
1430+
$ref: "#/components/schemas/ConnectorResourceAnnotations"
14181431

14191432
ConnectorNamespaceQuota:
14201433
type: object
@@ -1625,7 +1638,7 @@ components:
16251638
16261639
* Cluster: id, created_at, updated_at, owner, organisation_id, name, state, client_id
16271640
* Namespace: id, created_at, updated_at, name, cluster_id, owner, expiration, tenant_user_id, tenant_organisation_id, state
1628-
* Connector Types: id, created_at, updated_at, version, name, description, label, channel, featured_rank
1641+
* Connector Types: id, created_at, updated_at, version, name, description, label, channel, featured_rank, pricing_tier
16291642
* Connectors: id, created_at, updated_at, name, owner, organisation_id, connector_type_id, desired_state, state, channel, namespace_id, kafka_id, kafka_bootstrap_server, service_account_client_id, schema_registry_id, schema_registry_url
16301643
16311644
Allowed operators are `<>`, `=`, `LIKE`, or `ILIKE`.
@@ -1689,6 +1702,8 @@ components:
16891702
icon_href: "/api/connector_mgmt/v1/kafka_connector_types/log_sink.png"
16901703
labels:
16911704
- sink
1705+
annotations:
1706+
- "cos.bf2.org/name": value
16921707
capabilities:
16931708
- data_shape
16941709
- processors
@@ -1814,12 +1829,12 @@ components:
18141829
name: "MyNamespace"
18151830
cluster_id: "9bsv0s7tne7g02gh5g4g"
18161831
annotations:
1817-
"connector_mgmt.bf2.org/profile": "default-profile"
1832+
"cos.bf2.org/profile": "default-profile"
18181833
ConnectorNamespaceEvalCreateExample:
18191834
value:
18201835
name: "MyEvalNamespace"
18211836
annotations:
1822-
"connector_mgmt.bf2.org/profile": "evaluation-profile"
1837+
"cos.bf2.org/profile": "evaluation-profile"
18231838
400CreationExample:
18241839
value:
18251840
id: "103"

0 commit comments

Comments
 (0)