Skip to content

Commit 83bd0eb

Browse files
kong[bot]Guaris
andauthored
feat(sdk): automated oas update (#3297)
Co-authored-by: kong[bot] <123129154+kong[bot]@users.noreply.github.com> Co-authored-by: Angel <Guaris@users.noreply.github.com>
1 parent 68c7b74 commit 83bd0eb

File tree

22 files changed

+18333
-1344
lines changed

22 files changed

+18333
-1344
lines changed

api-specs/konnect/analytics-dashboards/openapi.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ info:
77
contact:
88
name: Kong
99
url: 'https://cloud.konghq.com'
10+
x-oas-source: kong/platform-api@b6321606a76ff4d736b45a17640baf5021adc6c6
11+
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/b6321606a76ff4d736b45a17640baf5021adc6c6'
1012
servers:
1113
- url: 'https://us.api.konghq.com/v2'
1214
description: United-States Production region

api-specs/konnect/analytics-requests/v2/openapi.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ info:
66
contact:
77
name: Kong
88
url: 'https://cloud.konghq.com'
9+
x-oas-source: kong/platform-api@b6321606a76ff4d736b45a17640baf5021adc6c6
10+
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/b6321606a76ff4d736b45a17640baf5021adc6c6'
911
servers:
1012
- url: 'https://us.api.konghq.com/v2'
1113
description: United-States Production region

api-specs/konnect/api-builder/v3/openapi.yaml

Lines changed: 54 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
openapi: 3.0.3
22
info:
33
title: Konnect API Builder
4-
version: 3.0.25
4+
version: 3.0.26
55
description: The management API for building APIs for Konnect Dev Portals.
66
contact:
77
name: Kong
88
url: 'https://cloud.konghq.com'
9+
x-oas-source: kong/platform-api@3a23fcee8d40e0fce64d7cfb28d51c270a2b9e28
10+
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/3a23fcee8d40e0fce64d7cfb28d51c270a2b9e28'
911
servers:
1012
- url: 'https://us.api.konghq.com/v3'
1113
description: United-States Production region
@@ -531,6 +533,7 @@ paths:
531533
- $ref: '#/components/parameters/PageSize'
532534
- $ref: '#/components/parameters/PageNumber'
533535
- $ref: '#/components/parameters/ApiVersionFilters'
536+
- $ref: '#/components/parameters/ApiVersionSort'
534537
responses:
535538
'200':
536539
$ref: '#/components/responses/ListApiVersionResponse'
@@ -917,6 +920,15 @@ components:
917920
schema:
918921
$ref: '#/components/schemas/ApiVersionFilterParameters'
919922
style: deepObject
923+
ApiVersionSort:
924+
name: sort
925+
description: |
926+
Sorts a collection of API versions. Supported sort attributes are:
927+
- created_at
928+
required: false
929+
in: query
930+
schema:
931+
$ref: '#/components/schemas/SortQuery'
920932
DocumentId:
921933
schema:
922934
type: string
@@ -1683,8 +1695,19 @@ components:
16831695
updated_at:
16841696
$ref: '#/components/schemas/DateTimeFieldFilter'
16851697
title: API Attribute Filter Parameters
1686-
StringFieldEqualsFilter:
1687-
description: Filters on the given string field value by exact match.
1698+
UuidFieldFilter:
1699+
description: 'Filter using **one** of the following operators: `oeq`, `neq`'
1700+
type: object
1701+
properties:
1702+
oeq:
1703+
description: The field matches any of the provided values.
1704+
type: string
1705+
example: '?filter[field_name_here][oeq]=foo,bar'
1706+
neq:
1707+
description: The field does not match the provided value.
1708+
type: string
1709+
example: '?filter[field_name_here][neq]=bar'
1710+
additionalProperties: false
16881711
oneOf:
16891712
- type: string
16901713
- type: object
@@ -1695,99 +1718,51 @@ components:
16951718
type: string
16961719
required:
16971720
- eq
1698-
title: StringFieldEqualsFilter
1699-
x-examples:
1700-
example-1: equals-some-value
1701-
example-2:
1702-
eq: some-value
1703-
StringFieldOEQFilter:
1704-
description: Returns entities that exact match any of the comma-delimited phrases in the filter string.
1705-
type: object
1706-
properties:
1707-
oeq:
1708-
type: string
1709-
additionalProperties: false
1710-
required:
1711-
- oeq
1712-
title: StringFieldOEQFilter
17131721
x-examples:
17141722
example-1:
17151723
oeq: 'some-value,some-other-value'
1716-
StringFieldNEQFilter:
1717-
description: Filters on the given string field value by exact match inequality.
1718-
type: object
1719-
properties:
1720-
neq:
1721-
type: string
1722-
additionalProperties: false
1723-
required:
1724-
- neq
1725-
title: StringFieldNEQFilter
1726-
x-examples:
1727-
example-1:
17281724
neq: not-this-value
1729-
UuidFieldFilter:
1730-
description: Filters on the given UUID field value by exact match.
1731-
oneOf:
1732-
- $ref: '#/components/schemas/StringFieldEqualsFilter'
1733-
- $ref: '#/components/schemas/StringFieldOEQFilter'
1734-
- $ref: '#/components/schemas/StringFieldNEQFilter'
1735-
title: UuidFieldFilter
1736-
x-examples:
1737-
example-1: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
17381725
example-2:
1739-
eq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
1740-
example-3:
1741-
oeq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
1742-
example-4:
1743-
neq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
1744-
StringFieldContainsFilter:
1745-
description: Filters on the given string field value by fuzzy match.
1726+
eq: some-value
1727+
StringFieldFilter:
1728+
description: 'Filter using **one** of the following operators: `oeq`, `neq`, `contains`, `ocontains`'
17461729
type: object
17471730
properties:
17481731
contains:
1732+
description: The field contains the provided value.
17491733
type: string
1750-
additionalProperties: false
1751-
required:
1752-
- contains
1753-
title: StringFieldContainsFilter
1754-
x-examples:
1755-
example-1:
1756-
contains: some-value
1757-
StringFieldOContainsFilter:
1758-
description: Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.
1759-
type: object
1760-
properties:
1734+
example: '?filter[field_name_here][contains]=foo'
17611735
ocontains:
1736+
description: The field contains any of the provided values.
1737+
type: string
1738+
example: '?filter[field_name_here][ocontains]=foo,bar'
1739+
oeq:
1740+
description: The field matches any of the provided values.
1741+
type: string
1742+
example: '?filter[field_name_here][oeq]=foo,bar'
1743+
neq:
1744+
description: The field does not match the provided value.
17621745
type: string
1746+
example: '?filter[field_name_here][neq]=bar'
17631747
additionalProperties: false
1764-
required:
1765-
- ocontains
1766-
title: StringFieldOContainsFilter
1748+
oneOf:
1749+
- type: string
1750+
- type: object
1751+
title: StringFieldEqualsComparison
1752+
additionalProperties: false
1753+
properties:
1754+
eq:
1755+
type: string
1756+
required:
1757+
- eq
17671758
x-examples:
17681759
example-1:
1760+
contains: some-value
17691761
ocontains: 'this-value,or-that-value'
1770-
StringFieldFilter:
1771-
description: Filters on the given string field value by either exact or fuzzy match.
1772-
oneOf:
1773-
- $ref: '#/components/schemas/StringFieldEqualsFilter'
1774-
- $ref: '#/components/schemas/StringFieldContainsFilter'
1775-
- $ref: '#/components/schemas/StringFieldOContainsFilter'
1776-
- $ref: '#/components/schemas/StringFieldOEQFilter'
1777-
- $ref: '#/components/schemas/StringFieldNEQFilter'
1778-
title: StringFieldFilter
1779-
x-examples:
1780-
example-1: equals-some-value
1762+
oeq: 'some-value,some-other-value'
1763+
neq: not-this-value
17811764
example-2:
17821765
eq: some-value
1783-
example-3:
1784-
contains: some-value
1785-
example-4:
1786-
ocontains: 'some-potential,value'
1787-
example-5:
1788-
oeq: 'some-potential,value'
1789-
example-6:
1790-
neq: not-this-value
17911766
LabelsFieldFilter:
17921767
allOf:
17931768
- title: LabelsFieldFilter

api-specs/konnect/api-products/v2/openapi.yaml

Lines changed: 48 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ info:
66
contact:
77
name: Kong
88
url: 'https://cloud.konghq.com'
9+
x-oas-source: kong/platform-api@3a23fcee8d40e0fce64d7cfb28d51c270a2b9e28
10+
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/3a23fcee8d40e0fce64d7cfb28d51c270a2b9e28'
911
servers:
1012
- url: 'https://us.api.konghq.com/v2'
1113
description: United-States Production region
@@ -1367,8 +1369,27 @@ components:
13671369
required:
13681370
- id
13691371
- control_plane_id
1370-
StringFieldEqualsFilter:
1371-
description: Filters on the given string field value by exact match.
1372+
StringFieldFilter:
1373+
description: 'Filter using **one** of the following operators: `oeq`, `neq`, `contains`, `ocontains`'
1374+
type: object
1375+
properties:
1376+
contains:
1377+
description: The field contains the provided value.
1378+
type: string
1379+
example: '?filter[field_name_here][contains]=foo'
1380+
ocontains:
1381+
description: The field contains any of the provided values.
1382+
type: string
1383+
example: '?filter[field_name_here][ocontains]=foo,bar'
1384+
oeq:
1385+
description: The field matches any of the provided values.
1386+
type: string
1387+
example: '?filter[field_name_here][oeq]=foo,bar'
1388+
neq:
1389+
description: The field does not match the provided value.
1390+
type: string
1391+
example: '?filter[field_name_here][neq]=bar'
1392+
additionalProperties: false
13721393
oneOf:
13731394
- type: string
13741395
- type: object
@@ -1379,84 +1400,14 @@ components:
13791400
type: string
13801401
required:
13811402
- eq
1382-
title: StringFieldEqualsFilter
1383-
x-examples:
1384-
example-1: equals-some-value
1385-
example-2:
1386-
eq: some-value
1387-
StringFieldContainsFilter:
1388-
description: Filters on the given string field value by fuzzy match.
1389-
type: object
1390-
properties:
1391-
contains:
1392-
type: string
1393-
additionalProperties: false
1394-
required:
1395-
- contains
1396-
title: StringFieldContainsFilter
13971403
x-examples:
13981404
example-1:
13991405
contains: some-value
1400-
StringFieldOContainsFilter:
1401-
description: Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.
1402-
type: object
1403-
properties:
1404-
ocontains:
1405-
type: string
1406-
additionalProperties: false
1407-
required:
1408-
- ocontains
1409-
title: StringFieldOContainsFilter
1410-
x-examples:
1411-
example-1:
14121406
ocontains: 'this-value,or-that-value'
1413-
StringFieldOEQFilter:
1414-
description: Returns entities that exact match any of the comma-delimited phrases in the filter string.
1415-
type: object
1416-
properties:
1417-
oeq:
1418-
type: string
1419-
additionalProperties: false
1420-
required:
1421-
- oeq
1422-
title: StringFieldOEQFilter
1423-
x-examples:
1424-
example-1:
14251407
oeq: 'some-value,some-other-value'
1426-
StringFieldNEQFilter:
1427-
description: Filters on the given string field value by exact match inequality.
1428-
type: object
1429-
properties:
1430-
neq:
1431-
type: string
1432-
additionalProperties: false
1433-
required:
1434-
- neq
1435-
title: StringFieldNEQFilter
1436-
x-examples:
1437-
example-1:
14381408
neq: not-this-value
1439-
StringFieldFilter:
1440-
description: Filters on the given string field value by either exact or fuzzy match.
1441-
oneOf:
1442-
- $ref: '#/components/schemas/StringFieldEqualsFilter'
1443-
- $ref: '#/components/schemas/StringFieldContainsFilter'
1444-
- $ref: '#/components/schemas/StringFieldOContainsFilter'
1445-
- $ref: '#/components/schemas/StringFieldOEQFilter'
1446-
- $ref: '#/components/schemas/StringFieldNEQFilter'
1447-
title: StringFieldFilter
1448-
x-examples:
1449-
example-1: equals-some-value
14501409
example-2:
14511410
eq: some-value
1452-
example-3:
1453-
contains: some-value
1454-
example-4:
1455-
ocontains: 'some-potential,value'
1456-
example-5:
1457-
oeq: 'some-potential,value'
1458-
example-6:
1459-
neq: not-this-value
14601411
SortQuery:
14611412
description: |
14621413
The `asc` suffix is optional as the default sort order is ascending.
@@ -2244,20 +2195,34 @@ components:
22442195
- checked
22452196
- type
22462197
UuidFieldFilter:
2247-
description: Filters on the given UUID field value by exact match.
2198+
description: 'Filter using **one** of the following operators: `oeq`, `neq`'
2199+
type: object
2200+
properties:
2201+
oeq:
2202+
description: The field matches any of the provided values.
2203+
type: string
2204+
example: '?filter[field_name_here][oeq]=foo,bar'
2205+
neq:
2206+
description: The field does not match the provided value.
2207+
type: string
2208+
example: '?filter[field_name_here][neq]=bar'
2209+
additionalProperties: false
22482210
oneOf:
2249-
- $ref: '#/components/schemas/StringFieldEqualsFilter'
2250-
- $ref: '#/components/schemas/StringFieldOEQFilter'
2251-
- $ref: '#/components/schemas/StringFieldNEQFilter'
2252-
title: UuidFieldFilter
2211+
- type: string
2212+
- type: object
2213+
title: StringFieldEqualsComparison
2214+
additionalProperties: false
2215+
properties:
2216+
eq:
2217+
type: string
2218+
required:
2219+
- eq
22532220
x-examples:
2254-
example-1: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
2221+
example-1:
2222+
oeq: 'some-value,some-other-value'
2223+
neq: not-this-value
22552224
example-2:
2256-
eq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
2257-
example-3:
2258-
oeq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
2259-
example-4:
2260-
neq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
2225+
eq: some-value
22612226
ConflictError:
22622227
allOf:
22632228
- $ref: '#/components/schemas/BaseError'

0 commit comments

Comments
 (0)