Skip to content

Commit 4fbd431

Browse files
committed
chore: update api docs GET /v2/clusters
Signed-off-by: Eoghan Lawless <[email protected]>
1 parent acbf350 commit 4fbd431

File tree

3 files changed

+28
-3
lines changed

3 files changed

+28
-3
lines changed

api/openapi/openapi.yaml

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,14 @@ paths:
3737
example: /v2/clusters?pageSize=20&offset=10
3838
- name: orderBy
3939
in: query
40-
description: The ordering of the entries. "asc" and "desc" are valid values. If none is specified, "asc" is used.
40+
description: |
41+
The ordering of the entries. "asc" and "desc" are valid values. If none is specified, "asc" is used.
42+
43+
Supported fields:
44+
- name
45+
- kubernetesVersion
46+
- providerStatus
47+
- lifecyclePhase
4148
schema:
4249
type: string
4350
examples:
@@ -52,7 +59,14 @@ paths:
5259
description: Sorts the entries by name in ascending order as default when no order is specified.
5360
- name: filter
5461
in: query
55-
description: Filters the entries based on the filter provided.
62+
description: |
63+
Filters the entries based on the filter provided.
64+
65+
Supported fields:
66+
- name
67+
- kubernetesVersion
68+
- providerStatus
69+
- lifecyclePhase
5670
schema:
5771
type: string
5872
examples:

internal/pagination/pagination.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,6 @@ func ValidateParams(params any) (pageSize, offset *int, orderBy, filter *string,
273273
"kubernetesVersion": true,
274274
"providerStatus": true,
275275
"lifecyclePhase": true,
276-
"version": true,
277276
}
278277
filterParts := strings.FieldsFunc(*filter, func(r rune) bool {
279278
return r == ' ' || r == 'O' || r == 'R' || r == 'A' || r == 'N' || r == 'D'

pkg/api/types.gen.go

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)