Skip to content

Commit 3a2124a

Browse files
fix(integration): correct integrationId filter documentation (#483)
Because - Example in this filter param contains the old `snake_case` format. This commit - Update documentation with a correct example. --------- Co-authored-by: droplet-bot <[email protected]>
1 parent 9f778f0 commit 3a2124a

File tree

2 files changed

+24
-39
lines changed

2 files changed

+24
-39
lines changed

openapiv2/vdp/service.swagger.yaml

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1453,9 +1453,7 @@ paths:
14531453
required: true
14541454
type: string
14551455
- name: pageSize
1456-
description: |-
1457-
The maximum number of items to return. The default and cap values are 10
1458-
and 100, respectively.
1456+
description: The maximum number of items to return. The default and cap values are 10 and 100, respectively.
14591457
in: query
14601458
required: false
14611459
type: integer
@@ -1467,16 +1465,14 @@ paths:
14671465
type: string
14681466
- name: filter
14691467
description: |-
1470-
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter
1471-
expression.
1468+
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression.
14721469
The following filters are supported:
14731470
- `integrationId`
14741471
- `qConnection` (fuzzy search on connection ID, integration title or vendor)
1475-
Examples:
1476-
- List connections where app name, vendor or connection ID match `googl`:
1477-
`q="googl"`.
1478-
- List connections where the component type is `openai` (e.g. to setup a
1479-
connector within a pipeline): `integration_id="openai"`.
1472+
1473+
**Examples**:
1474+
- List connections where app name, vendor or connection ID match `googl`: `q="googl"`.
1475+
- List connections where the component type is `openai` (e.g. to setup a connector within a pipeline): `integrationId="openai"`.
14801476
in: query
14811477
required: false
14821478
type: string
@@ -1839,9 +1835,7 @@ paths:
18391835
required: true
18401836
type: string
18411837
- name: pageSize
1842-
description: |-
1843-
The maximum number of items to return. The default and cap values are 10
1844-
and 100, respectively.
1838+
description: The maximum number of items to return. The default and cap values are 10 and 100, respectively.
18451839
in: query
18461840
required: false
18471841
type: integer
@@ -1853,8 +1847,7 @@ paths:
18531847
type: string
18541848
- name: filter
18551849
description: |-
1856-
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter
1857-
expression.
1850+
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression.
18581851
The following filters are supported:
18591852
- `q` (fuzzy search on pipeline ID)
18601853
in: query
@@ -1881,9 +1874,7 @@ paths:
18811874
$ref: '#/definitions/googlerpcStatus'
18821875
parameters:
18831876
- name: pageSize
1884-
description: |-
1885-
The maximum number of items to return. The default and cap values are 10
1886-
and 100, respectively.
1877+
description: The maximum number of items to return. The default and cap values are 10 and 100, respectively.
18871878
in: query
18881879
required: false
18891880
type: integer
@@ -1895,11 +1886,11 @@ paths:
18951886
type: string
18961887
- name: filter
18971888
description: |-
1898-
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter
1899-
expression.
1889+
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression.
19001890
The following filters are supported:
19011891
- `qIntegration` (fuzzy search on title or vendor)
1902-
Examples:
1892+
1893+
**Examples**:
19031894
- List integrations where app name or vendor match `googl`: `q="googl"`.
19041895
in: query
19051896
required: false

vdp/pipeline/v1beta/integration.proto

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -76,21 +76,18 @@ message Connection {
7676
message ListNamespaceConnectionsRequest {
7777
// Namespace ID.
7878
string namespace_id = 1 [(google.api.field_behavior) = REQUIRED];
79-
// The maximum number of items to return. The default and cap values are 10
80-
// and 100, respectively.
79+
// The maximum number of items to return. The default and cap values are 10 and 100, respectively.
8180
optional int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
8281
// Page token. By default, the first page will be returned.
8382
optional string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
84-
// Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter
85-
// expression.
83+
// Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression.
8684
// The following filters are supported:
8785
// - `integrationId`
8886
// - `qConnection` (fuzzy search on connection ID, integration title or vendor)
89-
// Examples:
90-
// - List connections where app name, vendor or connection ID match `googl`:
91-
// `q="googl"`.
92-
// - List connections where the component type is `openai` (e.g. to setup a
93-
// connector within a pipeline): `integration_id="openai"`.
87+
//
88+
// **Examples**:
89+
// - List connections where app name, vendor or connection ID match `googl`: `q="googl"`.
90+
// - List connections where the component type is `openai` (e.g. to setup a connector within a pipeline): `integrationId="openai"`.
9491
optional string filter = 4 [(google.api.field_behavior) = OPTIONAL];
9592
}
9693

@@ -271,13 +268,11 @@ message ListPipelineIDsByConnectionIDRequest {
271268
string namespace_id = 1 [(google.api.field_behavior) = REQUIRED];
272269
// Connection ID.
273270
string connection_id = 2 [(google.api.field_behavior) = REQUIRED];
274-
// The maximum number of items to return. The default and cap values are 10
275-
// and 100, respectively.
271+
// The maximum number of items to return. The default and cap values are 10 and 100, respectively.
276272
optional int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
277273
// Page token. By default, the first page will be returned.
278274
optional string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
279-
// Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter
280-
// expression.
275+
// Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression.
281276
// The following filters are supported:
282277
// - `q` (fuzzy search on pipeline ID)
283278
optional string filter = 5 [(google.api.field_behavior) = OPTIONAL];
@@ -296,16 +291,15 @@ message ListPipelineIDsByConnectionIDResponse {
296291
// ListIntegrationsRequest represents a request to list the available
297292
// integrations.
298293
message ListIntegrationsRequest {
299-
// The maximum number of items to return. The default and cap values are 10
300-
// and 100, respectively.
294+
// The maximum number of items to return. The default and cap values are 10 and 100, respectively.
301295
optional int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL];
302296
// Page token. By default, the first page will be returned.
303297
optional string page_token = 2 [(google.api.field_behavior) = OPTIONAL];
304-
// Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter
305-
// expression.
298+
// Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression.
306299
// The following filters are supported:
307300
// - `qIntegration` (fuzzy search on title or vendor)
308-
// Examples:
301+
//
302+
// **Examples**:
309303
// - List integrations where app name or vendor match `googl`: `q="googl"`.
310304
optional string filter = 3 [(google.api.field_behavior) = OPTIONAL];
311305
}

0 commit comments

Comments
 (0)