Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sdk): automated oas update #115

Merged
merged 2 commits into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 67 additions & 2 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2040,7 +2040,6 @@ components:
type: string
enum:
- required
- max_length
- is_array
- is_base64
- is_boolean
Expand Down Expand Up @@ -2098,6 +2097,8 @@ components:
- min_lowercase
- min_uppercase
- min_symbols
- min_items
- min
nullable: false
readOnly: true
minimum:
Expand All @@ -2108,14 +2109,46 @@ components:
example: body
reason:
type: string
example: is a required field
example: must have at least 8 characters
readOnly: true
additionalProperties: false
required:
- field
- reason
- rule
- minimum
InvalidParameterMaximumLength:
type: object
properties:
field:
type: string
example: name
readOnly: true
rule:
description: invalid parameters rules
type: string
enum:
- max_length
- max_items
- max
nullable: false
readOnly: true
maximum:
type: integer
example: 8
source:
type: string
example: body
reason:
type: string
example: must not have more than 8 characters
readOnly: true
additionalProperties: false
required:
- field
- reason
- rule
- maximum
InvalidParameterChoiceItem:
type: object
properties:
Expand Down Expand Up @@ -2190,6 +2223,7 @@ components:
oneOf:
- $ref: '#/components/schemas/InvalidParameterStandard'
- $ref: '#/components/schemas/InvalidParameterMinimumLength'
- $ref: '#/components/schemas/InvalidParameterMaximumLength'
- $ref: '#/components/schemas/InvalidParameterChoiceItem'
- $ref: '#/components/schemas/InvalidParameterDependentItem'
minItems: 1
Expand Down Expand Up @@ -2575,9 +2609,12 @@ components:
readOnly: true
latest_version:
$ref: '#/components/schemas/LatestVersion'
public_labels:
$ref: '#/components/schemas/PublicLabels'
additionalProperties: false
required:
- id
- public_labels
- created_at
- updated_at
- name
Expand Down Expand Up @@ -2858,6 +2895,23 @@ components:
- title
- content
title: ProductDocumentRaw
PublicLabels:
description: |
Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store **PUBLIC** metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
type: object
example:
category: finance
additionalProperties:
type: string
pattern: '^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$'
minLength: 1
maxLength: 63
maxProperties: 50
title: PublicLabels
NullableUUID:
description: Contains a unique identifier for a resource.
type: string
Expand Down Expand Up @@ -3523,6 +3577,8 @@ components:
required:
- name
- id
public_labels:
$ref: '#/components/schemas/PublicLabels'
additionalProperties: false
required:
- id
Expand All @@ -3532,6 +3588,7 @@ components:
- document_count
- version_count
- latest_version
- public_labels
title: ProductCatalogIndexSource
SearchIndicesParameters:
type: string
Expand Down Expand Up @@ -3859,6 +3916,8 @@ components:
description: Great products are built with great care
document_count: 5
version_count: 5
public_labels:
env: test
latest_version:
name: v5
id: 455b0beb-c3f7-4f8f-95f7-cd8ff0ee478e
Expand Down Expand Up @@ -4299,3 +4358,9 @@ tags:
all of the described endpoints will return a 404 error
- name: search
description: The API for Konnect Portal Search.
x-errors:
granted-scopes-unavailable:
description: |
The IDP used does not support granted scopes.
resolution: |
Switch to an IDP that allows you to grant specific scopes.
73 changes: 66 additions & 7 deletions src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1494,6 +1494,52 @@ export const InvalidParameterDependentItemRuleEnum = {

export type InvalidParameterDependentItemRuleEnum = typeof InvalidParameterDependentItemRuleEnum[keyof typeof InvalidParameterDependentItemRuleEnum];

/**
*
* @export
* @interface InvalidParameterMaximumLength
*/
export interface InvalidParameterMaximumLength {
/**
*
* @type {string}
* @memberof InvalidParameterMaximumLength
*/
'field': string;
/**
* invalid parameters rules
* @type {string}
* @memberof InvalidParameterMaximumLength
*/
'rule': InvalidParameterMaximumLengthRuleEnum;
/**
*
* @type {number}
* @memberof InvalidParameterMaximumLength
*/
'maximum': number;
/**
*
* @type {string}
* @memberof InvalidParameterMaximumLength
*/
'source'?: string;
/**
*
* @type {string}
* @memberof InvalidParameterMaximumLength
*/
'reason': string;
}

export const InvalidParameterMaximumLengthRuleEnum = {
MaxLength: 'max_length',
MaxItems: 'max_items',
Max: 'max'
} as const;

export type InvalidParameterMaximumLengthRuleEnum = typeof InvalidParameterMaximumLengthRuleEnum[keyof typeof InvalidParameterMaximumLengthRuleEnum];

/**
*
* @export
Expand Down Expand Up @@ -1533,11 +1579,13 @@ export interface InvalidParameterMinimumLength {
}

export const InvalidParameterMinimumLengthRuleEnum = {
Length: 'min_length',
Digits: 'min_digits',
Lowercase: 'min_lowercase',
Uppercase: 'min_uppercase',
Symbols: 'min_symbols'
MinLength: 'min_length',
MinDigits: 'min_digits',
MinLowercase: 'min_lowercase',
MinUppercase: 'min_uppercase',
MinSymbols: 'min_symbols',
MinItems: 'min_items',
Min: 'min'
} as const;

export type InvalidParameterMinimumLengthRuleEnum = typeof InvalidParameterMinimumLengthRuleEnum[keyof typeof InvalidParameterMinimumLengthRuleEnum];
Expand Down Expand Up @@ -1577,7 +1625,7 @@ export interface InvalidParameterStandard {
* @type InvalidParametersInner
* @export
*/
export type InvalidParametersInner = InvalidParameterChoiceItem | InvalidParameterDependentItem | InvalidParameterMinimumLength | InvalidParameterStandard;
export type InvalidParametersInner = InvalidParameterChoiceItem | InvalidParameterDependentItem | InvalidParameterMaximumLength | InvalidParameterMinimumLength | InvalidParameterStandard;

/**
* invalid parameters rules
Expand All @@ -1587,7 +1635,6 @@ export type InvalidParametersInner = InvalidParameterChoiceItem | InvalidParamet

export const InvalidRules = {
Required: 'required',
MaxLength: 'max_length',
IsArray: 'is_array',
IsBase64: 'is_base64',
IsBoolean: 'is_boolean',
Expand Down Expand Up @@ -2342,6 +2389,12 @@ export interface Product {
* @memberof Product
*/
'latest_version'?: LatestVersion | null;
/**
* Public labels store information about an entity that can be used for filtering a list of objects. Public labels are intended to store **PUBLIC** metadata. Keys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".
* @type {{ [key: string]: string; }}
* @memberof Product
*/
'public_labels': { [key: string]: string; };
}
/**
*
Expand Down Expand Up @@ -2435,6 +2488,12 @@ export interface ProductCatalogIndexSource {
* @memberof ProductCatalogIndexSource
*/
'latest_version': ProductCatalogIndexSourceLatestVersion | null;
/**
* Public labels store information about an entity that can be used for filtering a list of objects. Public labels are intended to store **PUBLIC** metadata. Keys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".
* @type {{ [key: string]: string; }}
* @memberof ProductCatalogIndexSource
*/
'public_labels': { [key: string]: string; };
}
/**
* Last created version.
Expand Down