-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
447979c
commit 900b2eb
Showing
13 changed files
with
127 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,9 +2,15 @@ openapi: 3.0.0 # need this as first line to allow some IDEs to know this is an o | |
# All endpoints defined here will be discoverable by all users. If there is a need to keep some endpoints | ||
# "private", add them to the "connector_mgmt-private.yaml" file | ||
info: | ||
title: Connector Service Fleet Manager | ||
title: Connector Management API | ||
version: 0.1.0 | ||
description: Connector Service Fleet Manager is a Rest API to manage connectors. | ||
description: Connector Management API is a REST API to manage connectors. | ||
license: | ||
name: 'Apache 2.0' | ||
url: 'https://www.apache.org/licenses/LICENSE-2.0' | ||
contact: | ||
name: 'Red Hat OpenShift Streams for Apache Kafka Support' | ||
email: '[email protected]' | ||
servers: | ||
- url: https://api.openshift.com | ||
description: Main (production) server | ||
|
@@ -23,7 +29,8 @@ tags: | |
description: "" | ||
- name: Connector Service | ||
description: "" | ||
|
||
- name : Connector Namespaces | ||
description: "" | ||
paths: | ||
# | ||
# Connector Service | ||
|
@@ -510,6 +517,8 @@ paths: | |
parameters: | ||
- $ref: "#/components/parameters/page" | ||
- $ref: "#/components/parameters/size" | ||
- $ref: "#/components/parameters/orderBy" | ||
- $ref: "#/components/parameters/search" | ||
responses: | ||
"200": | ||
content: | ||
|
@@ -986,18 +995,28 @@ components: | |
type: integer | ||
total: | ||
type: integer | ||
items: | ||
type: array | ||
items: | ||
$ref: "#/components/schemas/ObjectReference" | ||
|
||
Error: | ||
allOf: | ||
- $ref: "#/components/schemas/ObjectReference" | ||
- type: object | ||
properties: | ||
code: | ||
type: string | ||
reason: | ||
type: string | ||
operation_id: | ||
type: string | ||
type: object | ||
nullable: true | ||
required: [id, kind, href, code, reason] | ||
properties: | ||
reason: | ||
type: string | ||
operation_id: | ||
type: string | ||
id: | ||
type: string | ||
kind: | ||
type: string | ||
href: | ||
type: string | ||
code: | ||
type: string | ||
|
||
ObjectReference: | ||
type: object | ||
|
@@ -1265,17 +1284,11 @@ components: | |
# | ||
|
||
ConnectorType: | ||
description: >- | ||
Represents a connector type supported by the API | ||
oneOf: | ||
- required: | ||
- name | ||
- version | ||
- schema | ||
- required: | ||
- name | ||
- version | ||
- json_schema | ||
description: Represents a connector type supported by the API | ||
required: | ||
- name | ||
- version | ||
- schema | ||
allOf: | ||
- $ref: "#/components/schemas/ObjectReference" | ||
- type: object | ||
|
@@ -1312,11 +1325,6 @@ components: | |
A json schema that can be used to validate a ConnectorRequest | ||
connector field. | ||
type: object | ||
json_schema: | ||
description: >- | ||
A json schema that can be used to validate a ConnectorRequest | ||
connector field. | ||
type: object | ||
|
||
ConnectorTypeList: | ||
allOf: | ||
|
@@ -1516,7 +1524,7 @@ components: | |
description: |- | ||
Specifies the order by criteria. The syntax of this parameter is | ||
similar to the syntax of the `order by` clause of an SQL statement. | ||
Each query can be ordered by any of the `ConnectorType` fields. | ||
Each query can be ordered by any of the underlying resource fields supported in the search parameter. | ||
For example, to return all Connector types ordered by their name, use the following syntax: | ||
```sql | ||
|
@@ -1546,8 +1554,16 @@ components: | |
Search criteria. | ||
The syntax of this parameter is similar to the syntax of the `where` clause of a | ||
SQL statement. Allowed fields in the search are `name`, `description`, `version`, `label`, and `channel`. | ||
Allowed operators are `<>`, `=`, or `LIKE`. | ||
SQL statement. | ||
Allowed fields in the search depend on the resource type: | ||
* Cluster: id, created_at, updated_at, owner, organisation_id, name, state, client_id | ||
* Namespace: id, created_at, updated_at, name, cluster_id, owner, expiration, tenant_user_id, tenant_organisation_id, state | ||
* Connector Types: id, created_at, updated_at, version, name, description, label, channel | ||
* 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 | ||
Allowed operators are `<>`, `=`, `LIKE`, or `ILIKE`. | ||
Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query. | ||
Examples: | ||
|
@@ -1558,13 +1574,19 @@ components: | |
name = aws-sqs-source and channel = stable | ||
```[p-] | ||
To return a Kafka instance with a name that starts with `aws`, use the following syntax: | ||
To return a connector instance with a name that starts with `aws`, use the following syntax: | ||
``` | ||
name like aws%25 | ||
``` | ||
If the parameter isn't provided, or if the value is empty, then all the Connector Type | ||
To return a connector type with a name containing `aws` matching any character case combination, use the following syntax: | ||
``` | ||
name ilike %25aws%25 | ||
``` | ||
If the parameter isn't provided, or if the value is empty, then all the resources | ||
that the user has permission to see are returned. | ||
Note. If the query is invalid, an error is returned. | ||
|
@@ -1719,6 +1741,9 @@ components: | |
error_handling: | ||
dead_letter_queue: | ||
topic: "dlq" | ||
service_account: | ||
client_id: "SA-121212" | ||
client_secret: "secret" | ||
ConnectorNamespaceCreateExample: | ||
value: | ||
name: "MyNamespace" | ||
|
Oops, something went wrong.