diff --git a/openapi.yaml b/openapi.yaml index dc7248a..bb532ee 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -9,41 +9,6 @@ info: servers: - url: https://custom.example.com description: Production -tags: - - name: Application Analytics - description: >- - The API for querying Application Analytics. Application Analytics is only - available for private portals. - - name: applications - description: >- - The API for Konnect Portal developer applications within a private portal - (i.e. requires registration/authentication). When a portal is in `public` - mode, all of the described endpoints will return a 404 error. A public - portal means that applications and registrations are not available/needed. - In this API's context, "you" and "your" refers to the developer consuming - the API. - - name: credentials - description: >- - The API for Konnect Portal developer credentials within a private portal - (i.e. requires registration/authentication). - - name: developer - description: API for managing a Konnect Portal Developer. - - name: portal - description: The API for retrieving details about a single Konnect Portal. - - name: products - description: The API for Konnect Portal Products. - - name: versions - description: The API for Konnect Portal Product Versions. - - name: documentation - description: The API for Konnect Portal Product Documentation. - - name: registrations - description: > - The API for Konnect Portal application registrations. If the portal is - public - - all of the described endpoints will return a 404 error - - name: search - description: The API for Konnect Portal Search. paths: /api/v2/applications: get: @@ -884,6 +849,8 @@ paths: - $ref: '#/components/parameters/FilterByNameContains' - $ref: '#/components/parameters/FilterByStatusEquality' - $ref: '#/components/parameters/FilterByStatusEqualityShort' + - $ref: '#/components/parameters/FilterByAuthStrategyEquality' + - $ref: '#/components/parameters/FilterByAuthStrategyEqualityShort' - $ref: '#/components/parameters/QueryUnregisteredApplications' responses: '200': @@ -3881,24 +3848,6 @@ components: - self_managed_client_credentials - key_auth example: key_auth - FilterByAuthStrategyEquality: - name: filter[auth_strategy_id][eq] - description: Filter by the id of the auth strategy supported by the application. - in: query - required: false - schema: - type: string - example: 5be86298-147b-45ab-bfaf-a1bff97dce39 - FilterByAuthStrategyEqualityShort: - name: filter[auth_strategy_id] - description: >- - Filter by the id of the auth strategy supported by the application - (short-hand). - in: query - required: false - schema: - type: string - example: 5be86298-147b-45ab-bfaf-a1bff97dce39 PageSize: name: page[size] description: >- @@ -3949,6 +3898,24 @@ components: schema: type: string example: good service + FilterByAuthStrategyEquality: + name: filter[auth_strategy_id][eq] + description: Filter by the id of the auth strategy supported by the application. + in: query + required: false + schema: + type: string + example: 5be86298-147b-45ab-bfaf-a1bff97dce39 + FilterByAuthStrategyEqualityShort: + name: filter[auth_strategy_id] + description: >- + Filter by the id of the auth strategy supported by the application + (short-hand). + in: query + required: false + schema: + type: string + example: 5be86298-147b-45ab-bfaf-a1bff97dce39 ApplicationId: name: applicationId in: path @@ -4173,3 +4140,38 @@ components: application/json: schema: $ref: '#/components/schemas/CreateRegistrationPayload' +tags: + - name: Application Analytics + description: >- + The API for querying Application Analytics. Application Analytics is only + available for private portals. + - name: applications + description: >- + The API for Konnect Portal developer applications within a private portal + (i.e. requires registration/authentication). When a portal is in `public` + mode, all of the described endpoints will return a 404 error. A public + portal means that applications and registrations are not available/needed. + In this API's context, "you" and "your" refers to the developer consuming + the API. + - name: credentials + description: >- + The API for Konnect Portal developer credentials within a private portal + (i.e. requires registration/authentication). + - name: developer + description: API for managing a Konnect Portal Developer. + - name: portal + description: The API for retrieving details about a single Konnect Portal. + - name: products + description: The API for Konnect Portal Products. + - name: versions + description: The API for Konnect Portal Product Versions. + - name: documentation + description: The API for Konnect Portal Product Documentation. + - name: registrations + description: > + The API for Konnect Portal application registrations. If the portal is + public + + all of the described endpoints will return a 404 error + - name: search + description: The API for Konnect Portal Search. diff --git a/src/api.ts b/src/api.ts index e546202..43bc0e0 100644 --- a/src/api.ts +++ b/src/api.ts @@ -7282,11 +7282,13 @@ export const VersionsApiAxiosParamCreator = function (configuration?: Configurat * @param {string} [filterNameContains] Filter by contains comparison of the name property with a supplied substring * @param {'approved' | 'pending' | 'rejected' | 'revoked'} [filterStatusEq] Filter by direct equality comparison of the status property with a supplied value. * @param {'approved' | 'pending' | 'rejected' | 'revoked'} [filterStatus] Filter by direct equality comparison (short-hand) of the status property with a supplied value. + * @param {string} [filterAuthStrategyIdEq] Filter by the id of the auth strategy supported by the application. + * @param {string} [filterAuthStrategyId] Filter by the id of the auth strategy supported by the application (short-hand). * @param {boolean} [unregistered] Return applications that do **not** have a registration for the product version (regardless of registration status). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getApplicationsByProductVersion: async (productId: string, productVersionId: string, pageSize?: number, pageNumber?: number, filterNameEq?: string, filterName?: string, filterNameContains?: string, filterStatusEq?: 'approved' | 'pending' | 'rejected' | 'revoked', filterStatus?: 'approved' | 'pending' | 'rejected' | 'revoked', unregistered?: boolean, options: AxiosRequestConfig = {}): Promise => { + getApplicationsByProductVersion: async (productId: string, productVersionId: string, pageSize?: number, pageNumber?: number, filterNameEq?: string, filterName?: string, filterNameContains?: string, filterStatusEq?: 'approved' | 'pending' | 'rejected' | 'revoked', filterStatus?: 'approved' | 'pending' | 'rejected' | 'revoked', filterAuthStrategyIdEq?: string, filterAuthStrategyId?: string, unregistered?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'productId' is not null or undefined assertParamExists('getApplicationsByProductVersion', 'productId', productId) // verify required parameter 'productVersionId' is not null or undefined @@ -7335,6 +7337,14 @@ export const VersionsApiAxiosParamCreator = function (configuration?: Configurat localVarQueryParameter['filter[status]'] = filterStatus; } + if (filterAuthStrategyIdEq !== undefined) { + localVarQueryParameter['filter[auth_strategy_id][eq]'] = filterAuthStrategyIdEq; + } + + if (filterAuthStrategyId !== undefined) { + localVarQueryParameter['filter[auth_strategy_id]'] = filterAuthStrategyId; + } + if (unregistered !== undefined) { localVarQueryParameter['unregistered'] = unregistered; } @@ -7553,12 +7563,14 @@ export const VersionsApiFp = function(configuration?: Configuration) { * @param {string} [filterNameContains] Filter by contains comparison of the name property with a supplied substring * @param {'approved' | 'pending' | 'rejected' | 'revoked'} [filterStatusEq] Filter by direct equality comparison of the status property with a supplied value. * @param {'approved' | 'pending' | 'rejected' | 'revoked'} [filterStatus] Filter by direct equality comparison (short-hand) of the status property with a supplied value. + * @param {string} [filterAuthStrategyIdEq] Filter by the id of the auth strategy supported by the application. + * @param {string} [filterAuthStrategyId] Filter by the id of the auth strategy supported by the application (short-hand). * @param {boolean} [unregistered] Return applications that do **not** have a registration for the product version (regardless of registration status). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getApplicationsByProductVersion(productId: string, productVersionId: string, pageSize?: number, pageNumber?: number, filterNameEq?: string, filterName?: string, filterNameContains?: string, filterStatusEq?: 'approved' | 'pending' | 'rejected' | 'revoked', filterStatus?: 'approved' | 'pending' | 'rejected' | 'revoked', unregistered?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApplicationsByProductVersion(productId, productVersionId, pageSize, pageNumber, filterNameEq, filterName, filterNameContains, filterStatusEq, filterStatus, unregistered, options); + async getApplicationsByProductVersion(productId: string, productVersionId: string, pageSize?: number, pageNumber?: number, filterNameEq?: string, filterName?: string, filterNameContains?: string, filterStatusEq?: 'approved' | 'pending' | 'rejected' | 'revoked', filterStatus?: 'approved' | 'pending' | 'rejected' | 'revoked', filterAuthStrategyIdEq?: string, filterAuthStrategyId?: string, unregistered?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getApplicationsByProductVersion(productId, productVersionId, pageSize, pageNumber, filterNameEq, filterName, filterNameContains, filterStatusEq, filterStatus, filterAuthStrategyIdEq, filterAuthStrategyId, unregistered, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -7635,12 +7647,14 @@ export const VersionsApiFactory = function (configuration?: Configuration, baseP * @param {string} [filterNameContains] Filter by contains comparison of the name property with a supplied substring * @param {'approved' | 'pending' | 'rejected' | 'revoked'} [filterStatusEq] Filter by direct equality comparison of the status property with a supplied value. * @param {'approved' | 'pending' | 'rejected' | 'revoked'} [filterStatus] Filter by direct equality comparison (short-hand) of the status property with a supplied value. + * @param {string} [filterAuthStrategyIdEq] Filter by the id of the auth strategy supported by the application. + * @param {string} [filterAuthStrategyId] Filter by the id of the auth strategy supported by the application (short-hand). * @param {boolean} [unregistered] Return applications that do **not** have a registration for the product version (regardless of registration status). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getApplicationsByProductVersion(productId: string, productVersionId: string, pageSize?: number, pageNumber?: number, filterNameEq?: string, filterName?: string, filterNameContains?: string, filterStatusEq?: 'approved' | 'pending' | 'rejected' | 'revoked', filterStatus?: 'approved' | 'pending' | 'rejected' | 'revoked', unregistered?: boolean, options?: any): AxiosPromise { - return localVarFp.getApplicationsByProductVersion(productId, productVersionId, pageSize, pageNumber, filterNameEq, filterName, filterNameContains, filterStatusEq, filterStatus, unregistered, options).then((request) => request(axios, basePath)); + getApplicationsByProductVersion(productId: string, productVersionId: string, pageSize?: number, pageNumber?: number, filterNameEq?: string, filterName?: string, filterNameContains?: string, filterStatusEq?: 'approved' | 'pending' | 'rejected' | 'revoked', filterStatus?: 'approved' | 'pending' | 'rejected' | 'revoked', filterAuthStrategyIdEq?: string, filterAuthStrategyId?: string, unregistered?: boolean, options?: any): AxiosPromise { + return localVarFp.getApplicationsByProductVersion(productId, productVersionId, pageSize, pageNumber, filterNameEq, filterName, filterNameContains, filterStatusEq, filterStatus, filterAuthStrategyIdEq, filterAuthStrategyId, unregistered, options).then((request) => request(axios, basePath)); }, /** * Gets the details for an existing product version. @@ -7762,6 +7776,20 @@ export interface VersionsApiGetApplicationsByProductVersionRequest { */ readonly filterStatus?: 'approved' | 'pending' | 'rejected' | 'revoked' + /** + * Filter by the id of the auth strategy supported by the application. + * @type {string} + * @memberof VersionsApiGetApplicationsByProductVersion + */ + readonly filterAuthStrategyIdEq?: string + + /** + * Filter by the id of the auth strategy supported by the application (short-hand). + * @type {string} + * @memberof VersionsApiGetApplicationsByProductVersion + */ + readonly filterAuthStrategyId?: string + /** * Return applications that do **not** have a registration for the product version (regardless of registration status). * @type {boolean} @@ -7898,7 +7926,7 @@ export class VersionsApi extends BaseAPI { * @memberof VersionsApi */ public getApplicationsByProductVersion(requestParameters: VersionsApiGetApplicationsByProductVersionRequest, options?: AxiosRequestConfig) { - return VersionsApiFp(this.configuration).getApplicationsByProductVersion(requestParameters.productId, requestParameters.productVersionId, requestParameters.pageSize, requestParameters.pageNumber, requestParameters.filterNameEq, requestParameters.filterName, requestParameters.filterNameContains, requestParameters.filterStatusEq, requestParameters.filterStatus, requestParameters.unregistered, options).then((request) => request(this.axios, this.basePath)); + return VersionsApiFp(this.configuration).getApplicationsByProductVersion(requestParameters.productId, requestParameters.productVersionId, requestParameters.pageSize, requestParameters.pageNumber, requestParameters.filterNameEq, requestParameters.filterName, requestParameters.filterNameContains, requestParameters.filterStatusEq, requestParameters.filterStatus, requestParameters.filterAuthStrategyIdEq, requestParameters.filterAuthStrategyId, requestParameters.unregistered, options).then((request) => request(this.axios, this.basePath)); } /**