From 2b4ea16bdf6055ca305e80df3bd6d8908bdd1b6a Mon Sep 17 00:00:00 2001 From: Red Hat Application Services CI <84090353+app-services-ci@users.noreply.github.com> Date: Tue, 19 Jul 2022 11:58:37 +0100 Subject: [PATCH] fix(): update for SDK (#481) Co-authored-by: app-services-ci --- .../src/generated/api.ts | 4 +- .../src/generated/api/admin-api.ts | 531 +++++++----------- .../src/generated/api/artifact-rules-api.ts | 2 +- .../src/generated/api/artifacts-api.ts | 376 ++++++------- .../src/generated/api/global-rules-api.ts | 528 +++++++++++++++++ .../src/generated/api/metadata-api.ts | 2 +- .../src/generated/api/search-api.ts | 375 +++++++++++++ .../src/generated/api/system-api.ts | 73 ++- .../src/generated/api/users-api.ts | 2 +- .../src/generated/api/versions-api.ts | 146 ++++- .../src/generated/base.ts | 2 +- .../src/generated/common.ts | 2 +- .../src/generated/configuration.ts | 2 +- .../src/generated/index.ts | 2 +- .../src/generated/model/artifact-meta-data.ts | 9 +- .../src/generated/model/artifact-reference.ts | 48 ++ .../model/artifact-search-results.ts | 2 +- .../src/generated/model/artifact-state.ts | 2 +- .../src/generated/model/artifact-type.ts | 2 +- .../generated/model/configuration-property.ts | 54 ++ .../generated/model/content-create-request.ts | 37 ++ .../src/generated/model/download-ref.ts | 36 ++ .../src/generated/model/editable-meta-data.ts | 2 +- .../src/generated/model/if-exists.ts | 2 +- .../src/generated/model/index.ts | 6 + .../src/generated/model/limits.ts | 96 ++++ .../src/generated/model/log-configuration.ts | 2 +- .../src/generated/model/log-level.ts | 2 +- .../src/generated/model/model-error.ts | 2 +- .../model/named-log-configuration-all-of.ts | 2 +- .../model/named-log-configuration.ts | 2 +- .../src/generated/model/role-mapping.ts | 8 +- .../src/generated/model/role-type.ts | 2 +- .../src/generated/model/rule-type.ts | 2 +- .../generated/model/rule-violation-cause.ts | 2 +- .../model/rule-violation-error-all-of.ts | 2 +- .../generated/model/rule-violation-error.ts | 2 +- .../src/generated/model/rule.ts | 2 +- .../src/generated/model/searched-artifact.ts | 2 +- .../src/generated/model/searched-version.ts | 9 +- .../src/generated/model/sort-by.ts | 2 +- .../src/generated/model/sort-order.ts | 2 +- .../src/generated/model/system-info.ts | 2 +- .../model/update-configuration-property.ts | 30 + .../src/generated/model/update-role.ts | 2 +- .../src/generated/model/update-state.ts | 2 +- .../src/generated/model/user-info.ts | 2 +- .../src/generated/model/version-meta-data.ts | 2 +- .../generated/model/version-search-results.ts | 2 +- 49 files changed, 1844 insertions(+), 586 deletions(-) create mode 100644 packages/registry-instance-sdk/src/generated/api/global-rules-api.ts create mode 100644 packages/registry-instance-sdk/src/generated/api/search-api.ts create mode 100644 packages/registry-instance-sdk/src/generated/model/artifact-reference.ts create mode 100644 packages/registry-instance-sdk/src/generated/model/configuration-property.ts create mode 100644 packages/registry-instance-sdk/src/generated/model/content-create-request.ts create mode 100644 packages/registry-instance-sdk/src/generated/model/download-ref.ts create mode 100644 packages/registry-instance-sdk/src/generated/model/limits.ts create mode 100644 packages/registry-instance-sdk/src/generated/model/update-configuration-property.ts diff --git a/packages/registry-instance-sdk/src/generated/api.ts b/packages/registry-instance-sdk/src/generated/api.ts index 7bef278d..46bf69d3 100644 --- a/packages/registry-instance-sdk/src/generated/api.ts +++ b/packages/registry-instance-sdk/src/generated/api.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -17,7 +17,9 @@ export * from './api/admin-api'; export * from './api/artifact-rules-api'; export * from './api/artifacts-api'; +export * from './api/global-rules-api'; export * from './api/metadata-api'; +export * from './api/search-api'; export * from './api/system-api'; export * from './api/users-api'; export * from './api/versions-api'; diff --git a/packages/registry-instance-sdk/src/generated/api/admin-api.ts b/packages/registry-instance-sdk/src/generated/api/admin-api.ts index af5cf1a7..1b170a8c 100644 --- a/packages/registry-instance-sdk/src/generated/api/admin-api.ts +++ b/packages/registry-instance-sdk/src/generated/api/admin-api.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -21,15 +21,15 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; // @ts-ignore +import { ConfigurationProperty } from '../model'; +// @ts-ignore import { LogConfiguration } from '../model'; // @ts-ignore import { NamedLogConfiguration } from '../model'; // @ts-ignore import { RoleMapping } from '../model'; // @ts-ignore -import { Rule } from '../model'; -// @ts-ignore -import { RuleType } from '../model'; +import { UpdateConfigurationProperty } from '../model'; // @ts-ignore import { UpdateRole } from '../model'; /** @@ -38,42 +38,6 @@ import { UpdateRole } from '../model'; */ export const AdminApiAxiosParamCreator = function (configuration?: Configuration) { return { - /** - * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Create global rule - * @param {Rule} rule - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createGlobalRule: async (rule: Rule, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'rule' is not null or undefined - assertParamExists('createGlobalRule', 'rule', rule) - const localVarPath = `/admin/rules`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(rule, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * Creates a new mapping between a user/principal and a role. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) * @summary Create a new role mapping @@ -110,70 +74,6 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration options: localVarRequestOptions, }; }, - /** - * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary Delete all global rules - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteAllGlobalRules: async (options: AxiosRequestConfig = {}): Promise => { - const localVarPath = `/admin/rules`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Delete global rule - * @param {RuleType} rule The unique name/type of a rule. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteGlobalRule: async (rule: RuleType, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'rule' is not null or undefined - assertParamExists('deleteGlobalRule', 'rule', rule) - const localVarPath = `/admin/rules/{rule}` - .replace(`{${"rule"}}`, encodeURIComponent(String(rule))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * Deletes a single role mapping, effectively denying access to a user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Delete a role mapping @@ -211,10 +111,11 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration /** * Exports registry data as a ZIP archive. * @summary Export registry data + * @param {boolean} [forBrowser] Indicates if the operation is done for a browser. If true, the response will be a JSON payload with a property called `href`. This `href` will be a single-use, naked download link suitable for use by a web browser to download the content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - exportData: async (options: AxiosRequestConfig = {}): Promise => { + exportData: async (forBrowser?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/admin/export`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -227,6 +128,10 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (forBrowser !== undefined) { + localVarQueryParameter['forBrowser'] = forBrowser; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -239,17 +144,17 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Get global rule configuration - * @param {RuleType} rule The unique name/type of a rule. + * Returns the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get the value of a configuration property + * @param {string} propertyName The name of a configuration property. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGlobalRuleConfig: async (rule: RuleType, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'rule' is not null or undefined - assertParamExists('getGlobalRuleConfig', 'rule', rule) - const localVarPath = `/admin/rules/{rule}` - .replace(`{${"rule"}}`, encodeURIComponent(String(rule))); + getConfigProperty: async (propertyName: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'propertyName' is not null or undefined + assertParamExists('getConfigProperty', 'propertyName', propertyName) + const localVarPath = `/admin/config/properties/{propertyName}` + .replace(`{${"propertyName"}}`, encodeURIComponent(String(propertyName))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -344,10 +249,12 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration * Imports registry data that was previously exported using the `/admin/export` operation. * @summary Import registry data * @param {any} body The ZIP file representing the previously exported registry data. + * @param {boolean} [xRegistryPreserveGlobalId] If this header is set to false, global ids of imported data will be ignored and replaced by next id in global id sequence. This allows to import any data even thought the global ids would cause a conflict. + * @param {boolean} [xRegistryPreserveContentId] If this header is set to false, content ids of imported data will be ignored and replaced by next id in content id sequence. The mapping between content and artifacts will be preserved. This allows to import any data even thought the content ids would cause a conflict. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - importData: async (body: any, options: AxiosRequestConfig = {}): Promise => { + importData: async (body: any, xRegistryPreserveGlobalId?: boolean, xRegistryPreserveContentId?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'body' is not null or undefined assertParamExists('importData', 'body', body) const localVarPath = `/admin/import`; @@ -362,6 +269,14 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (xRegistryPreserveGlobalId !== undefined && xRegistryPreserveGlobalId !== null) { + localVarHeaderParameter['X-Registry-Preserve-GlobalId'] = String(JSON.stringify(xRegistryPreserveGlobalId)); + } + + if (xRegistryPreserveContentId !== undefined && xRegistryPreserveContentId !== null) { + localVarHeaderParameter['X-Registry-Preserve-ContentId'] = String(JSON.stringify(xRegistryPreserveContentId)); + } + localVarHeaderParameter['Content-Type'] = 'application/zip'; @@ -377,13 +292,13 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary List global rules + * Returns a list of all configuration properties that have been set. The list is not paged. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary List all configuration properties * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listGlobalRules: async (options: AxiosRequestConfig = {}): Promise => { - const localVarPath = `/admin/rules`; + listConfigProperties: async (options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/admin/config/properties`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -491,6 +406,40 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Resets the value of a single configuration property. This will return the property to its default value (see external documentation for supported properties and their default values). This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Reset a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + resetConfigProperty: async (propertyName: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'propertyName' is not null or undefined + assertParamExists('resetConfigProperty', 'propertyName', propertyName) + const localVarPath = `/admin/config/properties/{propertyName}` + .replace(`{${"propertyName"}}`, encodeURIComponent(String(propertyName))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -541,20 +490,20 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Update global rule configuration - * @param {RuleType} rule The unique name/type of a rule. - * @param {Rule} rule2 + * Updates the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {UpdateConfigurationProperty} updateConfigurationProperty * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateGlobalRuleConfig: async (rule: RuleType, rule2: Rule, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'rule' is not null or undefined - assertParamExists('updateGlobalRuleConfig', 'rule', rule) - // verify required parameter 'rule2' is not null or undefined - assertParamExists('updateGlobalRuleConfig', 'rule2', rule2) - const localVarPath = `/admin/rules/{rule}` - .replace(`{${"rule"}}`, encodeURIComponent(String(rule))); + updateConfigProperty: async (propertyName: string, updateConfigurationProperty: UpdateConfigurationProperty, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'propertyName' is not null or undefined + assertParamExists('updateConfigProperty', 'propertyName', propertyName) + // verify required parameter 'updateConfigurationProperty' is not null or undefined + assertParamExists('updateConfigProperty', 'updateConfigurationProperty', updateConfigurationProperty) + const localVarPath = `/admin/config/properties/{propertyName}` + .replace(`{${"propertyName"}}`, encodeURIComponent(String(propertyName))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -573,7 +522,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(rule2, localVarRequestOptions, configuration) + localVarRequestOptions.data = serializeDataIfNeeded(updateConfigurationProperty, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -630,17 +579,6 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration export const AdminApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = AdminApiAxiosParamCreator(configuration) return { - /** - * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Create global rule - * @param {Rule} rule - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createGlobalRule(rule: Rule, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createGlobalRule(rule, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, /** * Creates a new mapping between a user/principal and a role. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) * @summary Create a new role mapping @@ -652,27 +590,6 @@ export const AdminApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleMapping(roleMapping, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, - /** - * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary Delete all global rules - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteAllGlobalRules(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllGlobalRules(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Delete global rule - * @param {RuleType} rule The unique name/type of a rule. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteGlobalRule(rule: RuleType, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteGlobalRule(rule, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, /** * Deletes a single role mapping, effectively denying access to a user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Delete a role mapping @@ -687,22 +604,23 @@ export const AdminApiFp = function(configuration?: Configuration) { /** * Exports registry data as a ZIP archive. * @summary Export registry data + * @param {boolean} [forBrowser] Indicates if the operation is done for a browser. If true, the response will be a JSON payload with a property called `href`. This `href` will be a single-use, naked download link suitable for use by a web browser to download the content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async exportData(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportData(options); + async exportData(forBrowser?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportData(forBrowser, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Get global rule configuration - * @param {RuleType} rule The unique name/type of a rule. + * Returns the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get the value of a configuration property + * @param {string} propertyName The name of a configuration property. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getGlobalRuleConfig(rule: RuleType, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getGlobalRuleConfig(rule, options); + async getConfigProperty(propertyName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConfigProperty(propertyName, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -731,21 +649,23 @@ export const AdminApiFp = function(configuration?: Configuration) { * Imports registry data that was previously exported using the `/admin/export` operation. * @summary Import registry data * @param {any} body The ZIP file representing the previously exported registry data. + * @param {boolean} [xRegistryPreserveGlobalId] If this header is set to false, global ids of imported data will be ignored and replaced by next id in global id sequence. This allows to import any data even thought the global ids would cause a conflict. + * @param {boolean} [xRegistryPreserveContentId] If this header is set to false, content ids of imported data will be ignored and replaced by next id in content id sequence. The mapping between content and artifacts will be preserved. This allows to import any data even thought the content ids would cause a conflict. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async importData(body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importData(body, options); + async importData(body: any, xRegistryPreserveGlobalId?: boolean, xRegistryPreserveContentId?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importData(body, xRegistryPreserveGlobalId, xRegistryPreserveContentId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary List global rules + * Returns a list of all configuration properties that have been set. The list is not paged. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary List all configuration properties * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listGlobalRules(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listGlobalRules(options); + async listConfigProperties(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listConfigProperties(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -779,6 +699,17 @@ export const AdminApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.removeLogConfiguration(logger, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Resets the value of a single configuration property. This will return the property to its default value (see external documentation for supported properties and their default values). This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Reset a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async resetConfigProperty(propertyName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.resetConfigProperty(propertyName, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * Configures the logger referenced by the provided logger name with the given configuration. * @summary Set a logger\'s configuration @@ -792,15 +723,15 @@ export const AdminApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Update global rule configuration - * @param {RuleType} rule The unique name/type of a rule. - * @param {Rule} rule2 + * Updates the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {UpdateConfigurationProperty} updateConfigurationProperty * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateGlobalRuleConfig(rule: RuleType, rule2: Rule, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateGlobalRuleConfig(rule, rule2, options); + async updateConfigProperty(propertyName: string, updateConfigurationProperty: UpdateConfigurationProperty, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateConfigProperty(propertyName, updateConfigurationProperty, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -825,16 +756,6 @@ export const AdminApiFp = function(configuration?: Configuration) { export const AdminApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = AdminApiFp(configuration) return { - /** - * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Create global rule - * @param {Rule} rule - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createGlobalRule(rule: Rule, options?: any): AxiosPromise { - return localVarFp.createGlobalRule(rule, options).then((request) => request(axios, basePath)); - }, /** * Creates a new mapping between a user/principal and a role. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) * @summary Create a new role mapping @@ -845,25 +766,6 @@ export const AdminApiFactory = function (configuration?: Configuration, basePath createRoleMapping(roleMapping: RoleMapping, options?: any): AxiosPromise { return localVarFp.createRoleMapping(roleMapping, options).then((request) => request(axios, basePath)); }, - /** - * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary Delete all global rules - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteAllGlobalRules(options?: any): AxiosPromise { - return localVarFp.deleteAllGlobalRules(options).then((request) => request(axios, basePath)); - }, - /** - * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Delete global rule - * @param {RuleType} rule The unique name/type of a rule. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteGlobalRule(rule: RuleType, options?: any): AxiosPromise { - return localVarFp.deleteGlobalRule(rule, options).then((request) => request(axios, basePath)); - }, /** * Deletes a single role mapping, effectively denying access to a user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Delete a role mapping @@ -877,21 +779,22 @@ export const AdminApiFactory = function (configuration?: Configuration, basePath /** * Exports registry data as a ZIP archive. * @summary Export registry data + * @param {boolean} [forBrowser] Indicates if the operation is done for a browser. If true, the response will be a JSON payload with a property called `href`. This `href` will be a single-use, naked download link suitable for use by a web browser to download the content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - exportData(options?: any): AxiosPromise { - return localVarFp.exportData(options).then((request) => request(axios, basePath)); + exportData(forBrowser?: boolean, options?: any): AxiosPromise { + return localVarFp.exportData(forBrowser, options).then((request) => request(axios, basePath)); }, /** - * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Get global rule configuration - * @param {RuleType} rule The unique name/type of a rule. + * Returns the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get the value of a configuration property + * @param {string} propertyName The name of a configuration property. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGlobalRuleConfig(rule: RuleType, options?: any): AxiosPromise { - return localVarFp.getGlobalRuleConfig(rule, options).then((request) => request(axios, basePath)); + getConfigProperty(propertyName: string, options?: any): AxiosPromise { + return localVarFp.getConfigProperty(propertyName, options).then((request) => request(axios, basePath)); }, /** * Returns the configured logger configuration for the provided logger name, if no logger configuration is persisted it will return the current default log configuration in the system. @@ -917,20 +820,22 @@ export const AdminApiFactory = function (configuration?: Configuration, basePath * Imports registry data that was previously exported using the `/admin/export` operation. * @summary Import registry data * @param {any} body The ZIP file representing the previously exported registry data. + * @param {boolean} [xRegistryPreserveGlobalId] If this header is set to false, global ids of imported data will be ignored and replaced by next id in global id sequence. This allows to import any data even thought the global ids would cause a conflict. + * @param {boolean} [xRegistryPreserveContentId] If this header is set to false, content ids of imported data will be ignored and replaced by next id in content id sequence. The mapping between content and artifacts will be preserved. This allows to import any data even thought the content ids would cause a conflict. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - importData(body: any, options?: any): AxiosPromise { - return localVarFp.importData(body, options).then((request) => request(axios, basePath)); + importData(body: any, xRegistryPreserveGlobalId?: boolean, xRegistryPreserveContentId?: boolean, options?: any): AxiosPromise { + return localVarFp.importData(body, xRegistryPreserveGlobalId, xRegistryPreserveContentId, options).then((request) => request(axios, basePath)); }, /** - * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary List global rules + * Returns a list of all configuration properties that have been set. The list is not paged. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary List all configuration properties * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listGlobalRules(options?: any): AxiosPromise> { - return localVarFp.listGlobalRules(options).then((request) => request(axios, basePath)); + listConfigProperties(options?: any): AxiosPromise> { + return localVarFp.listConfigProperties(options).then((request) => request(axios, basePath)); }, /** * List all of the configured logging levels. These override the default logging configuration. @@ -960,6 +865,16 @@ export const AdminApiFactory = function (configuration?: Configuration, basePath removeLogConfiguration(logger: string, options?: any): AxiosPromise { return localVarFp.removeLogConfiguration(logger, options).then((request) => request(axios, basePath)); }, + /** + * Resets the value of a single configuration property. This will return the property to its default value (see external documentation for supported properties and their default values). This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Reset a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + resetConfigProperty(propertyName: string, options?: any): AxiosPromise { + return localVarFp.resetConfigProperty(propertyName, options).then((request) => request(axios, basePath)); + }, /** * Configures the logger referenced by the provided logger name with the given configuration. * @summary Set a logger\'s configuration @@ -972,15 +887,15 @@ export const AdminApiFactory = function (configuration?: Configuration, basePath return localVarFp.setLogConfiguration(logger, logConfiguration, options).then((request) => request(axios, basePath)); }, /** - * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Update global rule configuration - * @param {RuleType} rule The unique name/type of a rule. - * @param {Rule} rule2 + * Updates the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {UpdateConfigurationProperty} updateConfigurationProperty * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateGlobalRuleConfig(rule: RuleType, rule2: Rule, options?: any): AxiosPromise { - return localVarFp.updateGlobalRuleConfig(rule, rule2, options).then((request) => request(axios, basePath)); + updateConfigProperty(propertyName: string, updateConfigurationProperty: UpdateConfigurationProperty, options?: any): AxiosPromise { + return localVarFp.updateConfigProperty(propertyName, updateConfigurationProperty, options).then((request) => request(axios, basePath)); }, /** * Updates a single role mapping for one user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`) @@ -1002,16 +917,6 @@ export const AdminApiFactory = function (configuration?: Configuration, basePath * @interface AdminApi */ export interface AdminApiInterface { - /** - * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Create global rule - * @param {Rule} rule - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof AdminApiInterface - */ - createGlobalRule(rule: Rule, options?: AxiosRequestConfig): AxiosPromise; - /** * Creates a new mapping between a user/principal and a role. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) * @summary Create a new role mapping @@ -1022,25 +927,6 @@ export interface AdminApiInterface { */ createRoleMapping(roleMapping: RoleMapping, options?: AxiosRequestConfig): AxiosPromise; - /** - * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary Delete all global rules - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof AdminApiInterface - */ - deleteAllGlobalRules(options?: AxiosRequestConfig): AxiosPromise; - - /** - * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Delete global rule - * @param {RuleType} rule The unique name/type of a rule. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof AdminApiInterface - */ - deleteGlobalRule(rule: RuleType, options?: AxiosRequestConfig): AxiosPromise; - /** * Deletes a single role mapping, effectively denying access to a user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Delete a role mapping @@ -1054,21 +940,22 @@ export interface AdminApiInterface { /** * Exports registry data as a ZIP archive. * @summary Export registry data + * @param {boolean} [forBrowser] Indicates if the operation is done for a browser. If true, the response will be a JSON payload with a property called `href`. This `href` will be a single-use, naked download link suitable for use by a web browser to download the content. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApiInterface */ - exportData(options?: AxiosRequestConfig): AxiosPromise; + exportData(forBrowser?: boolean, options?: AxiosRequestConfig): AxiosPromise; /** - * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Get global rule configuration - * @param {RuleType} rule The unique name/type of a rule. + * Returns the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get the value of a configuration property + * @param {string} propertyName The name of a configuration property. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApiInterface */ - getGlobalRuleConfig(rule: RuleType, options?: AxiosRequestConfig): AxiosPromise; + getConfigProperty(propertyName: string, options?: AxiosRequestConfig): AxiosPromise; /** * Returns the configured logger configuration for the provided logger name, if no logger configuration is persisted it will return the current default log configuration in the system. @@ -1094,20 +981,22 @@ export interface AdminApiInterface { * Imports registry data that was previously exported using the `/admin/export` operation. * @summary Import registry data * @param {any} body The ZIP file representing the previously exported registry data. + * @param {boolean} [xRegistryPreserveGlobalId] If this header is set to false, global ids of imported data will be ignored and replaced by next id in global id sequence. This allows to import any data even thought the global ids would cause a conflict. + * @param {boolean} [xRegistryPreserveContentId] If this header is set to false, content ids of imported data will be ignored and replaced by next id in content id sequence. The mapping between content and artifacts will be preserved. This allows to import any data even thought the content ids would cause a conflict. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApiInterface */ - importData(body: any, options?: AxiosRequestConfig): AxiosPromise; + importData(body: any, xRegistryPreserveGlobalId?: boolean, xRegistryPreserveContentId?: boolean, options?: AxiosRequestConfig): AxiosPromise; /** - * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary List global rules + * Returns a list of all configuration properties that have been set. The list is not paged. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary List all configuration properties * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApiInterface */ - listGlobalRules(options?: AxiosRequestConfig): AxiosPromise>; + listConfigProperties(options?: AxiosRequestConfig): AxiosPromise>; /** * List all of the configured logging levels. These override the default logging configuration. @@ -1137,6 +1026,16 @@ export interface AdminApiInterface { */ removeLogConfiguration(logger: string, options?: AxiosRequestConfig): AxiosPromise; + /** + * Resets the value of a single configuration property. This will return the property to its default value (see external documentation for supported properties and their default values). This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Reset a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AdminApiInterface + */ + resetConfigProperty(propertyName: string, options?: AxiosRequestConfig): AxiosPromise; + /** * Configures the logger referenced by the provided logger name with the given configuration. * @summary Set a logger\'s configuration @@ -1149,15 +1048,15 @@ export interface AdminApiInterface { setLogConfiguration(logger: string, logConfiguration: LogConfiguration, options?: AxiosRequestConfig): AxiosPromise; /** - * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Update global rule configuration - * @param {RuleType} rule The unique name/type of a rule. - * @param {Rule} rule2 + * Updates the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {UpdateConfigurationProperty} updateConfigurationProperty * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApiInterface */ - updateGlobalRuleConfig(rule: RuleType, rule2: Rule, options?: AxiosRequestConfig): AxiosPromise; + updateConfigProperty(propertyName: string, updateConfigurationProperty: UpdateConfigurationProperty, options?: AxiosRequestConfig): AxiosPromise; /** * Updates a single role mapping for one user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`) @@ -1179,18 +1078,6 @@ export interface AdminApiInterface { * @extends {BaseAPI} */ export class AdminApi extends BaseAPI implements AdminApiInterface { - /** - * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Create global rule - * @param {Rule} rule - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof AdminApi - */ - public createGlobalRule(rule: Rule, options?: AxiosRequestConfig) { - return AdminApiFp(this.configuration).createGlobalRule(rule, options).then((request) => request(this.axios, this.basePath)); - } - /** * Creates a new mapping between a user/principal and a role. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) * @summary Create a new role mapping @@ -1203,29 +1090,6 @@ export class AdminApi extends BaseAPI implements AdminApiInterface { return AdminApiFp(this.configuration).createRoleMapping(roleMapping, options).then((request) => request(this.axios, this.basePath)); } - /** - * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary Delete all global rules - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof AdminApi - */ - public deleteAllGlobalRules(options?: AxiosRequestConfig) { - return AdminApiFp(this.configuration).deleteAllGlobalRules(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) - * @summary Delete global rule - * @param {RuleType} rule The unique name/type of a rule. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof AdminApi - */ - public deleteGlobalRule(rule: RuleType, options?: AxiosRequestConfig) { - return AdminApiFp(this.configuration).deleteGlobalRule(rule, options).then((request) => request(this.axios, this.basePath)); - } - /** * Deletes a single role mapping, effectively denying access to a user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Delete a role mapping @@ -1241,24 +1105,25 @@ export class AdminApi extends BaseAPI implements AdminApiInterface { /** * Exports registry data as a ZIP archive. * @summary Export registry data + * @param {boolean} [forBrowser] Indicates if the operation is done for a browser. If true, the response will be a JSON payload with a property called `href`. This `href` will be a single-use, naked download link suitable for use by a web browser to download the content. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApi */ - public exportData(options?: AxiosRequestConfig) { - return AdminApiFp(this.configuration).exportData(options).then((request) => request(this.axios, this.basePath)); + public exportData(forBrowser?: boolean, options?: AxiosRequestConfig) { + return AdminApiFp(this.configuration).exportData(forBrowser, options).then((request) => request(this.axios, this.basePath)); } /** - * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Get global rule configuration - * @param {RuleType} rule The unique name/type of a rule. + * Returns the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get the value of a configuration property + * @param {string} propertyName The name of a configuration property. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApi */ - public getGlobalRuleConfig(rule: RuleType, options?: AxiosRequestConfig) { - return AdminApiFp(this.configuration).getGlobalRuleConfig(rule, options).then((request) => request(this.axios, this.basePath)); + public getConfigProperty(propertyName: string, options?: AxiosRequestConfig) { + return AdminApiFp(this.configuration).getConfigProperty(propertyName, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1289,23 +1154,25 @@ export class AdminApi extends BaseAPI implements AdminApiInterface { * Imports registry data that was previously exported using the `/admin/export` operation. * @summary Import registry data * @param {any} body The ZIP file representing the previously exported registry data. + * @param {boolean} [xRegistryPreserveGlobalId] If this header is set to false, global ids of imported data will be ignored and replaced by next id in global id sequence. This allows to import any data even thought the global ids would cause a conflict. + * @param {boolean} [xRegistryPreserveContentId] If this header is set to false, content ids of imported data will be ignored and replaced by next id in content id sequence. The mapping between content and artifacts will be preserved. This allows to import any data even thought the content ids would cause a conflict. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApi */ - public importData(body: any, options?: AxiosRequestConfig) { - return AdminApiFp(this.configuration).importData(body, options).then((request) => request(this.axios, this.basePath)); + public importData(body: any, xRegistryPreserveGlobalId?: boolean, xRegistryPreserveContentId?: boolean, options?: AxiosRequestConfig) { + return AdminApiFp(this.configuration).importData(body, xRegistryPreserveGlobalId, xRegistryPreserveContentId, options).then((request) => request(this.axios, this.basePath)); } /** - * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) - * @summary List global rules + * Returns a list of all configuration properties that have been set. The list is not paged. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary List all configuration properties * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApi */ - public listGlobalRules(options?: AxiosRequestConfig) { - return AdminApiFp(this.configuration).listGlobalRules(options).then((request) => request(this.axios, this.basePath)); + public listConfigProperties(options?: AxiosRequestConfig) { + return AdminApiFp(this.configuration).listConfigProperties(options).then((request) => request(this.axios, this.basePath)); } /** @@ -1342,6 +1209,18 @@ export class AdminApi extends BaseAPI implements AdminApiInterface { return AdminApiFp(this.configuration).removeLogConfiguration(logger, options).then((request) => request(this.axios, this.basePath)); } + /** + * Resets the value of a single configuration property. This will return the property to its default value (see external documentation for supported properties and their default values). This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Reset a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AdminApi + */ + public resetConfigProperty(propertyName: string, options?: AxiosRequestConfig) { + return AdminApiFp(this.configuration).resetConfigProperty(propertyName, options).then((request) => request(this.axios, this.basePath)); + } + /** * Configures the logger referenced by the provided logger name with the given configuration. * @summary Set a logger\'s configuration @@ -1356,16 +1235,16 @@ export class AdminApi extends BaseAPI implements AdminApiInterface { } /** - * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) - * @summary Update global rule configuration - * @param {RuleType} rule The unique name/type of a rule. - * @param {Rule} rule2 + * Updates the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update a configuration property + * @param {string} propertyName The name of a configuration property. + * @param {UpdateConfigurationProperty} updateConfigurationProperty * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AdminApi */ - public updateGlobalRuleConfig(rule: RuleType, rule2: Rule, options?: AxiosRequestConfig) { - return AdminApiFp(this.configuration).updateGlobalRuleConfig(rule, rule2, options).then((request) => request(this.axios, this.basePath)); + public updateConfigProperty(propertyName: string, updateConfigurationProperty: UpdateConfigurationProperty, options?: AxiosRequestConfig) { + return AdminApiFp(this.configuration).updateConfigProperty(propertyName, updateConfigurationProperty, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/packages/registry-instance-sdk/src/generated/api/artifact-rules-api.ts b/packages/registry-instance-sdk/src/generated/api/artifact-rules-api.ts index 433e12bf..4bc58cc3 100644 --- a/packages/registry-instance-sdk/src/generated/api/artifact-rules-api.ts +++ b/packages/registry-instance-sdk/src/generated/api/artifact-rules-api.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/api/artifacts-api.ts b/packages/registry-instance-sdk/src/generated/api/artifacts-api.ts index 219c1e60..cbeb48a3 100644 --- a/packages/registry-instance-sdk/src/generated/api/artifacts-api.ts +++ b/packages/registry-instance-sdk/src/generated/api/artifacts-api.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -23,10 +23,14 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr // @ts-ignore import { ArtifactMetaData } from '../model'; // @ts-ignore +import { ArtifactReference } from '../model'; +// @ts-ignore import { ArtifactSearchResults } from '../model'; // @ts-ignore import { ArtifactType } from '../model'; // @ts-ignore +import { ContentCreateRequest } from '../model'; +// @ts-ignore import { IfExists } from '../model'; // @ts-ignore import { RuleViolationError } from '../model'; @@ -115,7 +119,7 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Content-Type'] = 'application/create.extended+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -203,10 +207,11 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura * Gets the content for an artifact version in the registry using its globally unique identifier. This operation may fail for one of the following reasons: * No artifact version with this `globalId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact by global ID * @param {number} globalId Global identifier for an artifact version. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getContentByGlobalId: async (globalId: number, options: AxiosRequestConfig = {}): Promise => { + getContentByGlobalId: async (globalId: number, dereference?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'globalId' is not null or undefined assertParamExists('getContentByGlobalId', 'globalId', globalId) const localVarPath = `/ids/globalIds/{globalId}` @@ -222,6 +227,10 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (dereference !== undefined) { + localVarQueryParameter['dereference'] = dereference; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -306,10 +315,11 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura * @summary Get latest artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLatestArtifact: async (groupId: string, artifactId: string, options: AxiosRequestConfig = {}): Promise => { + getLatestArtifact: async (groupId: string, artifactId: string, dereference?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'groupId' is not null or undefined assertParamExists('getLatestArtifact', 'groupId', groupId) // verify required parameter 'artifactId' is not null or undefined @@ -328,6 +338,10 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (dereference !== undefined) { + localVarQueryParameter['dereference'] = dereference; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -394,22 +408,17 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura }; }, /** - * Returns a paginated list of all artifacts that match the provided filter criteria. - * @summary Search for artifacts - * @param {string} [name] Filter by artifact name. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` - * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. - * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. - * @param {string} [description] Filter by description. - * @param {string} [group] Filter by artifact group. + * Returns a list containing all the artifact references using the artifact content hash. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given hash + * @param {string} contentHash SHA-256 content hash for a single artifact content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchArtifacts: async (name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, options: AxiosRequestConfig = {}): Promise => { - const localVarPath = `/search/artifacts`; + referencesByContentHash: async (contentHash: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'contentHash' is not null or undefined + assertParamExists('referencesByContentHash', 'contentHash', contentHash) + const localVarPath = `/ids/contentHashes/{contentHash}/references` + .replace(`{${"contentHash"}}`, encodeURIComponent(String(contentHash))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -421,42 +430,6 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (order !== undefined) { - localVarQueryParameter['order'] = order; - } - - if (orderby !== undefined) { - localVarQueryParameter['orderby'] = orderby; - } - - if (labels) { - localVarQueryParameter['labels'] = labels; - } - - if (properties) { - localVarQueryParameter['properties'] = properties; - } - - if (description !== undefined) { - localVarQueryParameter['description'] = description; - } - - if (group !== undefined) { - localVarQueryParameter['group'] = group; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -469,22 +442,17 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura }; }, /** - * Returns a paginated list of all artifacts with at least one version that matches the posted content. - * @summary Search for artifacts by content - * @param {any} body The content to search for. - * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. - * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * Returns a list containing all the artifact references using the artifact contentId. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given content id. + * @param {number} contentId Global identifier for a single artifact content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchArtifactsByContent: async (body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'body' is not null or undefined - assertParamExists('searchArtifactsByContent', 'body', body) - const localVarPath = `/search/artifacts`; + referencesByContentId: async (contentId: number, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'contentId' is not null or undefined + assertParamExists('referencesByContentId', 'contentId', contentId) + const localVarPath = `/ids/contentIds/{contentId}/references` + .replace(`{${"contentId"}}`, encodeURIComponent(String(contentId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -492,42 +460,49 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (canonical !== undefined) { - localVarQueryParameter['canonical'] = canonical; - } - - if (artifactType !== undefined) { - localVarQueryParameter['artifactType'] = artifactType; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (order !== undefined) { - localVarQueryParameter['order'] = order; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns a list containing all the artifact references using the artifact global id. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given global id. + * @param {number} globalId Global identifier for an artifact version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + referencesByGlobalId: async (globalId: number, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'globalId' is not null or undefined + assertParamExists('referencesByGlobalId', 'globalId', globalId) + const localVarPath = `/ids/globalIds/{globalId}/references` + .replace(`{${"globalId"}}`, encodeURIComponent(String(globalId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (orderby !== undefined) { - localVarQueryParameter['orderby'] = orderby; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -535,7 +510,7 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura }; }, /** - * Updates an artifact by uploading new content. The body of the request should be the raw content of the artifact. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. + * Updates an artifact by uploading new content. The body of the request can be the raw content of the artifact or a JSON object containing both the raw content and a set of references to other artifacts.. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. * @summary Update artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. @@ -591,7 +566,7 @@ export const ArtifactsApiAxiosParamCreator = function (configuration?: Configura - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Content-Type'] = 'application/create.extended+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -705,11 +680,12 @@ export const ArtifactsApiFp = function(configuration?: Configuration) { * Gets the content for an artifact version in the registry using its globally unique identifier. This operation may fail for one of the following reasons: * No artifact version with this `globalId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact by global ID * @param {number} globalId Global identifier for an artifact version. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getContentByGlobalId(globalId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getContentByGlobalId(globalId, options); + async getContentByGlobalId(globalId: number, dereference?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getContentByGlobalId(globalId, dereference, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -739,11 +715,12 @@ export const ArtifactsApiFp = function(configuration?: Configuration) { * @summary Get latest artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getLatestArtifact(groupId: string, artifactId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestArtifact(groupId, artifactId, options); + async getLatestArtifact(groupId: string, artifactId: string, dereference?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestArtifact(groupId, artifactId, dereference, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -762,43 +739,40 @@ export const ArtifactsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a paginated list of all artifacts that match the provided filter criteria. - * @summary Search for artifacts - * @param {string} [name] Filter by artifact name. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` - * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. - * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. - * @param {string} [description] Filter by description. - * @param {string} [group] Filter by artifact group. + * Returns a list containing all the artifact references using the artifact content hash. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given hash + * @param {string} contentHash SHA-256 content hash for a single artifact content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async searchArtifacts(name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchArtifacts(name, offset, limit, order, orderby, labels, properties, description, group, options); + async referencesByContentHash(contentHash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.referencesByContentHash(contentHash, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a paginated list of all artifacts with at least one version that matches the posted content. - * @summary Search for artifacts by content - * @param {any} body The content to search for. - * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. - * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * Returns a list containing all the artifact references using the artifact contentId. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given content id. + * @param {number} contentId Global identifier for a single artifact content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async referencesByContentId(contentId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.referencesByContentId(contentId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns a list containing all the artifact references using the artifact global id. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given global id. + * @param {number} globalId Global identifier for an artifact version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async searchArtifactsByContent(body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchArtifactsByContent(body, canonical, artifactType, offset, limit, order, orderby, options); + async referencesByGlobalId(globalId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.referencesByGlobalId(globalId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Updates an artifact by uploading new content. The body of the request should be the raw content of the artifact. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. + * Updates an artifact by uploading new content. The body of the request can be the raw content of the artifact or a JSON object containing both the raw content and a set of references to other artifacts.. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. * @summary Update artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. @@ -883,11 +857,12 @@ export const ArtifactsApiFactory = function (configuration?: Configuration, base * Gets the content for an artifact version in the registry using its globally unique identifier. This operation may fail for one of the following reasons: * No artifact version with this `globalId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact by global ID * @param {number} globalId Global identifier for an artifact version. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getContentByGlobalId(globalId: number, options?: any): AxiosPromise { - return localVarFp.getContentByGlobalId(globalId, options).then((request) => request(axios, basePath)); + getContentByGlobalId(globalId: number, dereference?: boolean, options?: any): AxiosPromise { + return localVarFp.getContentByGlobalId(globalId, dereference, options).then((request) => request(axios, basePath)); }, /** * Gets the content for an artifact version in the registry using the SHA-256 hash of the content. This content hash may be shared by multiple artifact versions in the case where the artifact versions have identical content. This operation may fail for one of the following reasons: * No content with this `contentHash` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) @@ -914,11 +889,12 @@ export const ArtifactsApiFactory = function (configuration?: Configuration, base * @summary Get latest artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLatestArtifact(groupId: string, artifactId: string, options?: any): AxiosPromise { - return localVarFp.getLatestArtifact(groupId, artifactId, options).then((request) => request(axios, basePath)); + getLatestArtifact(groupId: string, artifactId: string, dereference?: boolean, options?: any): AxiosPromise { + return localVarFp.getLatestArtifact(groupId, artifactId, dereference, options).then((request) => request(axios, basePath)); }, /** * Returns a list of all artifacts in the group. This list is paged. @@ -935,41 +911,37 @@ export const ArtifactsApiFactory = function (configuration?: Configuration, base return localVarFp.listArtifactsInGroup(groupId, limit, offset, order, orderby, options).then((request) => request(axios, basePath)); }, /** - * Returns a paginated list of all artifacts that match the provided filter criteria. - * @summary Search for artifacts - * @param {string} [name] Filter by artifact name. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` - * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. - * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. - * @param {string} [description] Filter by description. - * @param {string} [group] Filter by artifact group. + * Returns a list containing all the artifact references using the artifact content hash. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given hash + * @param {string} contentHash SHA-256 content hash for a single artifact content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchArtifacts(name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, options?: any): AxiosPromise { - return localVarFp.searchArtifacts(name, offset, limit, order, orderby, labels, properties, description, group, options).then((request) => request(axios, basePath)); + referencesByContentHash(contentHash: string, options?: any): AxiosPromise> { + return localVarFp.referencesByContentHash(contentHash, options).then((request) => request(axios, basePath)); }, /** - * Returns a paginated list of all artifacts with at least one version that matches the posted content. - * @summary Search for artifacts by content - * @param {any} body The content to search for. - * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. - * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * Returns a list containing all the artifact references using the artifact contentId. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given content id. + * @param {number} contentId Global identifier for a single artifact content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchArtifactsByContent(body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options?: any): AxiosPromise { - return localVarFp.searchArtifactsByContent(body, canonical, artifactType, offset, limit, order, orderby, options).then((request) => request(axios, basePath)); + referencesByContentId(contentId: number, options?: any): AxiosPromise> { + return localVarFp.referencesByContentId(contentId, options).then((request) => request(axios, basePath)); }, /** - * Updates an artifact by uploading new content. The body of the request should be the raw content of the artifact. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. + * Returns a list containing all the artifact references using the artifact global id. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given global id. + * @param {number} globalId Global identifier for an artifact version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + referencesByGlobalId(globalId: number, options?: any): AxiosPromise> { + return localVarFp.referencesByGlobalId(globalId, options).then((request) => request(axios, basePath)); + }, + /** + * Updates an artifact by uploading new content. The body of the request can be the raw content of the artifact or a JSON object containing both the raw content and a set of references to other artifacts.. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. * @summary Update artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. @@ -1051,11 +1023,12 @@ export interface ArtifactsApiInterface { * Gets the content for an artifact version in the registry using its globally unique identifier. This operation may fail for one of the following reasons: * No artifact version with this `globalId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact by global ID * @param {number} globalId Global identifier for an artifact version. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArtifactsApiInterface */ - getContentByGlobalId(globalId: number, options?: AxiosRequestConfig): AxiosPromise; + getContentByGlobalId(globalId: number, dereference?: boolean, options?: AxiosRequestConfig): AxiosPromise; /** * Gets the content for an artifact version in the registry using the SHA-256 hash of the content. This content hash may be shared by multiple artifact versions in the case where the artifact versions have identical content. This operation may fail for one of the following reasons: * No content with this `contentHash` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) @@ -1082,11 +1055,12 @@ export interface ArtifactsApiInterface { * @summary Get latest artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArtifactsApiInterface */ - getLatestArtifact(groupId: string, artifactId: string, options?: AxiosRequestConfig): AxiosPromise; + getLatestArtifact(groupId: string, artifactId: string, dereference?: boolean, options?: AxiosRequestConfig): AxiosPromise; /** * Returns a list of all artifacts in the group. This list is paged. @@ -1103,41 +1077,37 @@ export interface ArtifactsApiInterface { listArtifactsInGroup(groupId: string, limit?: number, offset?: number, order?: SortOrder, orderby?: SortBy, options?: AxiosRequestConfig): AxiosPromise; /** - * Returns a paginated list of all artifacts that match the provided filter criteria. - * @summary Search for artifacts - * @param {string} [name] Filter by artifact name. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` - * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. - * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. - * @param {string} [description] Filter by description. - * @param {string} [group] Filter by artifact group. + * Returns a list containing all the artifact references using the artifact content hash. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given hash + * @param {string} contentHash SHA-256 content hash for a single artifact content. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArtifactsApiInterface */ - searchArtifacts(name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, options?: AxiosRequestConfig): AxiosPromise; + referencesByContentHash(contentHash: string, options?: AxiosRequestConfig): AxiosPromise>; /** - * Returns a paginated list of all artifacts with at least one version that matches the posted content. - * @summary Search for artifacts by content - * @param {any} body The content to search for. - * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. - * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * Returns a list containing all the artifact references using the artifact contentId. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given content id. + * @param {number} contentId Global identifier for a single artifact content. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArtifactsApiInterface */ - searchArtifactsByContent(body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options?: AxiosRequestConfig): AxiosPromise; + referencesByContentId(contentId: number, options?: AxiosRequestConfig): AxiosPromise>; /** - * Updates an artifact by uploading new content. The body of the request should be the raw content of the artifact. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. + * Returns a list containing all the artifact references using the artifact global id. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given global id. + * @param {number} globalId Global identifier for an artifact version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArtifactsApiInterface + */ + referencesByGlobalId(globalId: number, options?: AxiosRequestConfig): AxiosPromise>; + + /** + * Updates an artifact by uploading new content. The body of the request can be the raw content of the artifact or a JSON object containing both the raw content and a set of references to other artifacts.. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. * @summary Update artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. @@ -1225,12 +1195,13 @@ export class ArtifactsApi extends BaseAPI implements ArtifactsApiInterface { * Gets the content for an artifact version in the registry using its globally unique identifier. This operation may fail for one of the following reasons: * No artifact version with this `globalId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact by global ID * @param {number} globalId Global identifier for an artifact version. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArtifactsApi */ - public getContentByGlobalId(globalId: number, options?: AxiosRequestConfig) { - return ArtifactsApiFp(this.configuration).getContentByGlobalId(globalId, options).then((request) => request(this.axios, this.basePath)); + public getContentByGlobalId(globalId: number, dereference?: boolean, options?: AxiosRequestConfig) { + return ArtifactsApiFp(this.configuration).getContentByGlobalId(globalId, dereference, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1262,12 +1233,13 @@ export class ArtifactsApi extends BaseAPI implements ArtifactsApiInterface { * @summary Get latest artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArtifactsApi */ - public getLatestArtifact(groupId: string, artifactId: string, options?: AxiosRequestConfig) { - return ArtifactsApiFp(this.configuration).getLatestArtifact(groupId, artifactId, options).then((request) => request(this.axios, this.basePath)); + public getLatestArtifact(groupId: string, artifactId: string, dereference?: boolean, options?: AxiosRequestConfig) { + return ArtifactsApiFp(this.configuration).getLatestArtifact(groupId, artifactId, dereference, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1287,45 +1259,43 @@ export class ArtifactsApi extends BaseAPI implements ArtifactsApiInterface { } /** - * Returns a paginated list of all artifacts that match the provided filter criteria. - * @summary Search for artifacts - * @param {string} [name] Filter by artifact name. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` - * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. - * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. - * @param {string} [description] Filter by description. - * @param {string} [group] Filter by artifact group. + * Returns a list containing all the artifact references using the artifact content hash. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given hash + * @param {string} contentHash SHA-256 content hash for a single artifact content. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArtifactsApi */ - public searchArtifacts(name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, options?: AxiosRequestConfig) { - return ArtifactsApiFp(this.configuration).searchArtifacts(name, offset, limit, order, orderby, labels, properties, description, group, options).then((request) => request(this.axios, this.basePath)); + public referencesByContentHash(contentHash: string, options?: AxiosRequestConfig) { + return ArtifactsApiFp(this.configuration).referencesByContentHash(contentHash, options).then((request) => request(this.axios, this.basePath)); } /** - * Returns a paginated list of all artifacts with at least one version that matches the posted content. - * @summary Search for artifacts by content - * @param {any} body The content to search for. - * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. - * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. - * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. - * @param {number} [limit] The number of artifacts to return. Defaults to 20. - * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). - * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * Returns a list containing all the artifact references using the artifact contentId. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given content id. + * @param {number} contentId Global identifier for a single artifact content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArtifactsApi + */ + public referencesByContentId(contentId: number, options?: AxiosRequestConfig) { + return ArtifactsApiFp(this.configuration).referencesByContentId(contentId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a list containing all the artifact references using the artifact global id. This operation may fail for one of the following reasons: * A server error occurred (HTTP error `500`) + * @summary Returns a list with all the references for the artifact with the given global id. + * @param {number} globalId Global identifier for an artifact version. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArtifactsApi */ - public searchArtifactsByContent(body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options?: AxiosRequestConfig) { - return ArtifactsApiFp(this.configuration).searchArtifactsByContent(body, canonical, artifactType, offset, limit, order, orderby, options).then((request) => request(this.axios, this.basePath)); + public referencesByGlobalId(globalId: number, options?: AxiosRequestConfig) { + return ArtifactsApiFp(this.configuration).referencesByGlobalId(globalId, options).then((request) => request(this.axios, this.basePath)); } /** - * Updates an artifact by uploading new content. The body of the request should be the raw content of the artifact. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. + * Updates an artifact by uploading new content. The body of the request can be the raw content of the artifact or a JSON object containing both the raw content and a set of references to other artifacts.. This is typically in JSON format for *most* of the supported types, but may be in another format for a few (for example, `PROTOBUF`). The type of the content should be compatible with the artifact\'s type (it would be an error to update an `AVRO` artifact with new `OPENAPI` content, for example). The update could fail for a number of reasons including: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact. * @summary Update artifact * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. diff --git a/packages/registry-instance-sdk/src/generated/api/global-rules-api.ts b/packages/registry-instance-sdk/src/generated/api/global-rules-api.ts new file mode 100644 index 00000000..fcb534a0 --- /dev/null +++ b/packages/registry-instance-sdk/src/generated/api/global-rules-api.ts @@ -0,0 +1,528 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Apicurio Registry API [v2] + * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. + * + * The version of the OpenAPI document: 2.2.5.Final + * Contact: apicurio@lists.jboss.org + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { Rule } from '../model'; +// @ts-ignore +import { RuleType } from '../model'; +/** + * GlobalRulesApi - axios parameter creator + * @export + */ +export const GlobalRulesApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Create global rule + * @param {Rule} rule + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createGlobalRule: async (rule: Rule, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'rule' is not null or undefined + assertParamExists('createGlobalRule', 'rule', rule) + const localVarPath = `/admin/rules`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(rule, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary Delete all global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAllGlobalRules: async (options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/admin/rules`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Delete global rule + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteGlobalRule: async (rule: RuleType, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'rule' is not null or undefined + assertParamExists('deleteGlobalRule', 'rule', rule) + const localVarPath = `/admin/rules/{rule}` + .replace(`{${"rule"}}`, encodeURIComponent(String(rule))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getGlobalRuleConfig: async (rule: RuleType, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'rule' is not null or undefined + assertParamExists('getGlobalRuleConfig', 'rule', rule) + const localVarPath = `/admin/rules/{rule}` + .replace(`{${"rule"}}`, encodeURIComponent(String(rule))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary List global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listGlobalRules: async (options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/admin/rules`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {Rule} rule2 + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateGlobalRuleConfig: async (rule: RuleType, rule2: Rule, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'rule' is not null or undefined + assertParamExists('updateGlobalRuleConfig', 'rule', rule) + // verify required parameter 'rule2' is not null or undefined + assertParamExists('updateGlobalRuleConfig', 'rule2', rule2) + const localVarPath = `/admin/rules/{rule}` + .replace(`{${"rule"}}`, encodeURIComponent(String(rule))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(rule2, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * GlobalRulesApi - functional programming interface + * @export + */ +export const GlobalRulesApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = GlobalRulesApiAxiosParamCreator(configuration) + return { + /** + * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Create global rule + * @param {Rule} rule + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createGlobalRule(rule: Rule, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createGlobalRule(rule, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary Delete all global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteAllGlobalRules(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllGlobalRules(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Delete global rule + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteGlobalRule(rule: RuleType, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteGlobalRule(rule, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getGlobalRuleConfig(rule: RuleType, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getGlobalRuleConfig(rule, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary List global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listGlobalRules(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listGlobalRules(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {Rule} rule2 + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateGlobalRuleConfig(rule: RuleType, rule2: Rule, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateGlobalRuleConfig(rule, rule2, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * GlobalRulesApi - factory interface + * @export + */ +export const GlobalRulesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = GlobalRulesApiFp(configuration) + return { + /** + * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Create global rule + * @param {Rule} rule + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createGlobalRule(rule: Rule, options?: any): AxiosPromise { + return localVarFp.createGlobalRule(rule, options).then((request) => request(axios, basePath)); + }, + /** + * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary Delete all global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAllGlobalRules(options?: any): AxiosPromise { + return localVarFp.deleteAllGlobalRules(options).then((request) => request(axios, basePath)); + }, + /** + * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Delete global rule + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteGlobalRule(rule: RuleType, options?: any): AxiosPromise { + return localVarFp.deleteGlobalRule(rule, options).then((request) => request(axios, basePath)); + }, + /** + * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getGlobalRuleConfig(rule: RuleType, options?: any): AxiosPromise { + return localVarFp.getGlobalRuleConfig(rule, options).then((request) => request(axios, basePath)); + }, + /** + * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary List global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listGlobalRules(options?: any): AxiosPromise> { + return localVarFp.listGlobalRules(options).then((request) => request(axios, basePath)); + }, + /** + * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {Rule} rule2 + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateGlobalRuleConfig(rule: RuleType, rule2: Rule, options?: any): AxiosPromise { + return localVarFp.updateGlobalRuleConfig(rule, rule2, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * GlobalRulesApi - interface + * @export + * @interface GlobalRulesApi + */ +export interface GlobalRulesApiInterface { + /** + * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Create global rule + * @param {Rule} rule + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApiInterface + */ + createGlobalRule(rule: Rule, options?: AxiosRequestConfig): AxiosPromise; + + /** + * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary Delete all global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApiInterface + */ + deleteAllGlobalRules(options?: AxiosRequestConfig): AxiosPromise; + + /** + * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Delete global rule + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApiInterface + */ + deleteGlobalRule(rule: RuleType, options?: AxiosRequestConfig): AxiosPromise; + + /** + * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApiInterface + */ + getGlobalRuleConfig(rule: RuleType, options?: AxiosRequestConfig): AxiosPromise; + + /** + * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary List global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApiInterface + */ + listGlobalRules(options?: AxiosRequestConfig): AxiosPromise>; + + /** + * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {Rule} rule2 + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApiInterface + */ + updateGlobalRuleConfig(rule: RuleType, rule2: Rule, options?: AxiosRequestConfig): AxiosPromise; + +} + +/** + * GlobalRulesApi - object-oriented interface + * @export + * @class GlobalRulesApi + * @extends {BaseAPI} + */ +export class GlobalRulesApi extends BaseAPI implements GlobalRulesApiInterface { + /** + * Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Create global rule + * @param {Rule} rule + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApi + */ + public createGlobalRule(rule: Rule, options?: AxiosRequestConfig) { + return GlobalRulesApiFp(this.configuration).createGlobalRule(rule, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary Delete all global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApi + */ + public deleteAllGlobalRules(options?: AxiosRequestConfig) { + return GlobalRulesApiFp(this.configuration).deleteAllGlobalRules(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Rule cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`) + * @summary Delete global rule + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApi + */ + public deleteGlobalRule(rule: RuleType, options?: AxiosRequestConfig) { + return GlobalRulesApiFp(this.configuration).deleteGlobalRule(rule, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApi + */ + public getGlobalRuleConfig(rule: RuleType, options?: AxiosRequestConfig) { + return GlobalRulesApiFp(this.configuration).getGlobalRuleConfig(rule, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`) + * @summary List global rules + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApi + */ + public listGlobalRules(options?: AxiosRequestConfig) { + return GlobalRulesApiFp(this.configuration).listGlobalRules(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Update global rule configuration + * @param {RuleType} rule The unique name/type of a rule. + * @param {Rule} rule2 + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GlobalRulesApi + */ + public updateGlobalRuleConfig(rule: RuleType, rule2: Rule, options?: AxiosRequestConfig) { + return GlobalRulesApiFp(this.configuration).updateGlobalRuleConfig(rule, rule2, options).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/packages/registry-instance-sdk/src/generated/api/metadata-api.ts b/packages/registry-instance-sdk/src/generated/api/metadata-api.ts index afa10d78..5c6b8d97 100644 --- a/packages/registry-instance-sdk/src/generated/api/metadata-api.ts +++ b/packages/registry-instance-sdk/src/generated/api/metadata-api.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/api/search-api.ts b/packages/registry-instance-sdk/src/generated/api/search-api.ts new file mode 100644 index 00000000..151f6ddf --- /dev/null +++ b/packages/registry-instance-sdk/src/generated/api/search-api.ts @@ -0,0 +1,375 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Apicurio Registry API [v2] + * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. + * + * The version of the OpenAPI document: 2.2.5.Final + * Contact: apicurio@lists.jboss.org + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { ArtifactSearchResults } from '../model'; +// @ts-ignore +import { ArtifactType } from '../model'; +// @ts-ignore +import { SortBy } from '../model'; +// @ts-ignore +import { SortOrder } from '../model'; +/** + * SearchApi - axios parameter creator + * @export + */ +export const SearchApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Returns a paginated list of all artifacts that match the provided filter criteria. + * @summary Search for artifacts + * @param {string} [name] Filter by artifact name. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. + * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. + * @param {string} [description] Filter by description. + * @param {string} [group] Filter by artifact group. + * @param {number} [globalId] Filter by globalId. + * @param {number} [contentId] Filter by contentId. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + searchArtifacts: async (name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, globalId?: number, contentId?: number, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/search/artifacts`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (name !== undefined) { + localVarQueryParameter['name'] = name; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (orderby !== undefined) { + localVarQueryParameter['orderby'] = orderby; + } + + if (labels) { + localVarQueryParameter['labels'] = labels; + } + + if (properties) { + localVarQueryParameter['properties'] = properties; + } + + if (description !== undefined) { + localVarQueryParameter['description'] = description; + } + + if (group !== undefined) { + localVarQueryParameter['group'] = group; + } + + if (globalId !== undefined) { + localVarQueryParameter['globalId'] = globalId; + } + + if (contentId !== undefined) { + localVarQueryParameter['contentId'] = contentId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns a paginated list of all artifacts with at least one version that matches the posted content. + * @summary Search for artifacts by content + * @param {any} body The content to search for. + * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. + * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + searchArtifactsByContent: async (body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'body' is not null or undefined + assertParamExists('searchArtifactsByContent', 'body', body) + const localVarPath = `/search/artifacts`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (canonical !== undefined) { + localVarQueryParameter['canonical'] = canonical; + } + + if (artifactType !== undefined) { + localVarQueryParameter['artifactType'] = artifactType; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (orderby !== undefined) { + localVarQueryParameter['orderby'] = orderby; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * SearchApi - functional programming interface + * @export + */ +export const SearchApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SearchApiAxiosParamCreator(configuration) + return { + /** + * Returns a paginated list of all artifacts that match the provided filter criteria. + * @summary Search for artifacts + * @param {string} [name] Filter by artifact name. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. + * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. + * @param {string} [description] Filter by description. + * @param {string} [group] Filter by artifact group. + * @param {number} [globalId] Filter by globalId. + * @param {number} [contentId] Filter by contentId. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async searchArtifacts(name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, globalId?: number, contentId?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchArtifacts(name, offset, limit, order, orderby, labels, properties, description, group, globalId, contentId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns a paginated list of all artifacts with at least one version that matches the posted content. + * @summary Search for artifacts by content + * @param {any} body The content to search for. + * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. + * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async searchArtifactsByContent(body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchArtifactsByContent(body, canonical, artifactType, offset, limit, order, orderby, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * SearchApi - factory interface + * @export + */ +export const SearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SearchApiFp(configuration) + return { + /** + * Returns a paginated list of all artifacts that match the provided filter criteria. + * @summary Search for artifacts + * @param {string} [name] Filter by artifact name. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. + * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. + * @param {string} [description] Filter by description. + * @param {string} [group] Filter by artifact group. + * @param {number} [globalId] Filter by globalId. + * @param {number} [contentId] Filter by contentId. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + searchArtifacts(name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, globalId?: number, contentId?: number, options?: any): AxiosPromise { + return localVarFp.searchArtifacts(name, offset, limit, order, orderby, labels, properties, description, group, globalId, contentId, options).then((request) => request(axios, basePath)); + }, + /** + * Returns a paginated list of all artifacts with at least one version that matches the posted content. + * @summary Search for artifacts by content + * @param {any} body The content to search for. + * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. + * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + searchArtifactsByContent(body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options?: any): AxiosPromise { + return localVarFp.searchArtifactsByContent(body, canonical, artifactType, offset, limit, order, orderby, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * SearchApi - interface + * @export + * @interface SearchApi + */ +export interface SearchApiInterface { + /** + * Returns a paginated list of all artifacts that match the provided filter criteria. + * @summary Search for artifacts + * @param {string} [name] Filter by artifact name. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. + * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. + * @param {string} [description] Filter by description. + * @param {string} [group] Filter by artifact group. + * @param {number} [globalId] Filter by globalId. + * @param {number} [contentId] Filter by contentId. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SearchApiInterface + */ + searchArtifacts(name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, globalId?: number, contentId?: number, options?: AxiosRequestConfig): AxiosPromise; + + /** + * Returns a paginated list of all artifacts with at least one version that matches the posted content. + * @summary Search for artifacts by content + * @param {any} body The content to search for. + * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. + * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SearchApiInterface + */ + searchArtifactsByContent(body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options?: AxiosRequestConfig): AxiosPromise; + +} + +/** + * SearchApi - object-oriented interface + * @export + * @class SearchApi + * @extends {BaseAPI} + */ +export class SearchApi extends BaseAPI implements SearchApiInterface { + /** + * Returns a paginated list of all artifacts that match the provided filter criteria. + * @summary Search for artifacts + * @param {string} [name] Filter by artifact name. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {SortOrder} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {SortBy} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {Array} [labels] Filter by label. Include one or more label to only return artifacts containing all of the specified labels. + * @param {Array} [properties] Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`. + * @param {string} [description] Filter by description. + * @param {string} [group] Filter by artifact group. + * @param {number} [globalId] Filter by globalId. + * @param {number} [contentId] Filter by contentId. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SearchApi + */ + public searchArtifacts(name?: string, offset?: number, limit?: number, order?: SortOrder, orderby?: SortBy, labels?: Array, properties?: Array, description?: string, group?: string, globalId?: number, contentId?: number, options?: AxiosRequestConfig) { + return SearchApiFp(this.configuration).searchArtifacts(name, offset, limit, order, orderby, labels, properties, description, group, globalId, contentId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a paginated list of all artifacts with at least one version that matches the posted content. + * @summary Search for artifacts by content + * @param {any} body The content to search for. + * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter. + * @param {ArtifactType} [artifactType] Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts. + * @param {number} [offset] The number of artifacts to skip before starting to collect the result set. Defaults to 0. + * @param {number} [limit] The number of artifacts to return. Defaults to 20. + * @param {'asc' | 'desc'} [order] Sort order, ascending (`asc`) or descending (`desc`). + * @param {'name' | 'createdOn'} [orderby] The field to sort by. Can be one of: * `name` * `createdOn` + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SearchApi + */ + public searchArtifactsByContent(body: any, canonical?: boolean, artifactType?: ArtifactType, offset?: number, limit?: number, order?: 'asc' | 'desc', orderby?: 'name' | 'createdOn', options?: AxiosRequestConfig) { + return SearchApiFp(this.configuration).searchArtifactsByContent(body, canonical, artifactType, offset, limit, order, orderby, options).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/packages/registry-instance-sdk/src/generated/api/system-api.ts b/packages/registry-instance-sdk/src/generated/api/system-api.ts index dc86a508..1f5f3231 100644 --- a/packages/registry-instance-sdk/src/generated/api/system-api.ts +++ b/packages/registry-instance-sdk/src/generated/api/system-api.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; // @ts-ignore +import { Limits } from '../model'; +// @ts-ignore import { SystemInfo } from '../model'; /** * SystemApi - axios parameter creator @@ -28,6 +30,36 @@ import { SystemInfo } from '../model'; */ export const SystemApiAxiosParamCreator = function (configuration?: Configuration) { return { + /** + * This operation retrieves the list of limitations on used resources, that are applied on the current instance of Registry. + * @summary Get resource limits information + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceLimits: async (options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/system/limits`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * This operation retrieves information about the running registry system, such as the version of the software and when it was built. * @summary Get system information @@ -68,6 +100,16 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio export const SystemApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = SystemApiAxiosParamCreator(configuration) return { + /** + * This operation retrieves the list of limitations on used resources, that are applied on the current instance of Registry. + * @summary Get resource limits information + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getResourceLimits(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getResourceLimits(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * This operation retrieves information about the running registry system, such as the version of the software and when it was built. * @summary Get system information @@ -88,6 +130,15 @@ export const SystemApiFp = function(configuration?: Configuration) { export const SystemApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = SystemApiFp(configuration) return { + /** + * This operation retrieves the list of limitations on used resources, that are applied on the current instance of Registry. + * @summary Get resource limits information + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceLimits(options?: any): AxiosPromise { + return localVarFp.getResourceLimits(options).then((request) => request(axios, basePath)); + }, /** * This operation retrieves information about the running registry system, such as the version of the software and when it was built. * @summary Get system information @@ -106,6 +157,15 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat * @interface SystemApi */ export interface SystemApiInterface { + /** + * This operation retrieves the list of limitations on used resources, that are applied on the current instance of Registry. + * @summary Get resource limits information + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SystemApiInterface + */ + getResourceLimits(options?: AxiosRequestConfig): AxiosPromise; + /** * This operation retrieves information about the running registry system, such as the version of the software and when it was built. * @summary Get system information @@ -124,6 +184,17 @@ export interface SystemApiInterface { * @extends {BaseAPI} */ export class SystemApi extends BaseAPI implements SystemApiInterface { + /** + * This operation retrieves the list of limitations on used resources, that are applied on the current instance of Registry. + * @summary Get resource limits information + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SystemApi + */ + public getResourceLimits(options?: AxiosRequestConfig) { + return SystemApiFp(this.configuration).getResourceLimits(options).then((request) => request(this.axios, this.basePath)); + } + /** * This operation retrieves information about the running registry system, such as the version of the software and when it was built. * @summary Get system information diff --git a/packages/registry-instance-sdk/src/generated/api/users-api.ts b/packages/registry-instance-sdk/src/generated/api/users-api.ts index a2dd3691..ca3fed98 100644 --- a/packages/registry-instance-sdk/src/generated/api/users-api.ts +++ b/packages/registry-instance-sdk/src/generated/api/users-api.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/api/versions-api.ts b/packages/registry-instance-sdk/src/generated/api/versions-api.ts index dd9c14ab..20077354 100644 --- a/packages/registry-instance-sdk/src/generated/api/versions-api.ts +++ b/packages/registry-instance-sdk/src/generated/api/versions-api.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; // @ts-ignore +import { ArtifactReference } from '../model'; +// @ts-ignore +import { ContentCreateRequest } from '../model'; +// @ts-ignore import { RuleViolationError } from '../model'; // @ts-ignore import { UpdateState } from '../model'; @@ -35,11 +39,11 @@ import { VersionSearchResults } from '../model'; export const VersionsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request should be the raw content of the new artifact version, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) + * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request can be the raw content of the new artifact version, or the raw content and a set of references pointing to other artifacts, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) * @summary Create artifact version * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. - * @param {any} body The content of the artifact version being created. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) + * @param {any} body The content of the artifact version being created or the content and a set of references to other artifacts. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) * @param {string} [xRegistryVersion] Specifies the version number of this new version of the artifact content. This would typically be a simple integer or a SemVer value. It must be unique within the artifact. If this is not provided, the server will generate a new, unique version number for this new updated content. * @param {string} [xRegistryName] Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content. * @param {string} [xRegistryDescription] Specifies the artifact description of this new version of the artifact content. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content. @@ -91,7 +95,7 @@ export const VersionsApiAxiosParamCreator = function (configuration?: Configurat - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Content-Type'] = 'application/create.extended+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -109,10 +113,11 @@ export const VersionsApiAxiosParamCreator = function (configuration?: Configurat * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. * @param {string} version The unique identifier of a specific version of the artifact content. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getArtifactVersion: async (groupId: string, artifactId: string, version: string, options: AxiosRequestConfig = {}): Promise => { + getArtifactVersion: async (groupId: string, artifactId: string, version: string, dereference?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'groupId' is not null or undefined assertParamExists('getArtifactVersion', 'groupId', groupId) // verify required parameter 'artifactId' is not null or undefined @@ -134,6 +139,52 @@ export const VersionsApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (dereference !== undefined) { + localVarQueryParameter['dereference'] = dereference; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Retrieves a single version of the artifact content. Both the `artifactId` and the unique `version` number must be provided. The `Content-Type` of the response depends on the artifact type. In most cases, this is `application/json`, but for some types it may be different (for example, `PROTOBUF`). This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * No version with this `version` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get artifact version + * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. + * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {string} version The unique identifier of a specific version of the artifact content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArtifactVersionReferences: async (groupId: string, artifactId: string, version: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'groupId' is not null or undefined + assertParamExists('getArtifactVersionReferences', 'groupId', groupId) + // verify required parameter 'artifactId' is not null or undefined + assertParamExists('getArtifactVersionReferences', 'artifactId', artifactId) + // verify required parameter 'version' is not null or undefined + assertParamExists('getArtifactVersionReferences', 'version', version) + const localVarPath = `/groups/{groupId}/artifacts/{artifactId}/versions/{version}/references` + .replace(`{${"groupId"}}`, encodeURIComponent(String(groupId))) + .replace(`{${"artifactId"}}`, encodeURIComponent(String(artifactId))) + .replace(`{${"version"}}`, encodeURIComponent(String(version))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -252,11 +303,11 @@ export const VersionsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = VersionsApiAxiosParamCreator(configuration) return { /** - * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request should be the raw content of the new artifact version, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) + * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request can be the raw content of the new artifact version, or the raw content and a set of references pointing to other artifacts, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) * @summary Create artifact version * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. - * @param {any} body The content of the artifact version being created. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) + * @param {any} body The content of the artifact version being created or the content and a set of references to other artifacts. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) * @param {string} [xRegistryVersion] Specifies the version number of this new version of the artifact content. This would typically be a simple integer or a SemVer value. It must be unique within the artifact. If this is not provided, the server will generate a new, unique version number for this new updated content. * @param {string} [xRegistryName] Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content. * @param {string} [xRegistryDescription] Specifies the artifact description of this new version of the artifact content. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content. @@ -269,6 +320,20 @@ export const VersionsApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.createArtifactVersion(groupId, artifactId, body, xRegistryVersion, xRegistryName, xRegistryDescription, xRegistryDescriptionEncoded, xRegistryNameEncoded, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Retrieves a single version of the artifact content. Both the `artifactId` and the unique `version` number must be provided. The `Content-Type` of the response depends on the artifact type. In most cases, this is `application/json`, but for some types it may be different (for example, `PROTOBUF`). This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * No version with this `version` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get artifact version + * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. + * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {string} version The unique identifier of a specific version of the artifact content. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getArtifactVersion(groupId: string, artifactId: string, version: string, dereference?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactVersion(groupId, artifactId, version, dereference, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * Retrieves a single version of the artifact content. Both the `artifactId` and the unique `version` number must be provided. The `Content-Type` of the response depends on the artifact type. In most cases, this is `application/json`, but for some types it may be different (for example, `PROTOBUF`). This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * No version with this `version` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact version @@ -278,8 +343,8 @@ export const VersionsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getArtifactVersion(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactVersion(groupId, artifactId, version, options); + async getArtifactVersionReferences(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactVersionReferences(groupId, artifactId, version, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -321,11 +386,11 @@ export const VersionsApiFactory = function (configuration?: Configuration, baseP const localVarFp = VersionsApiFp(configuration) return { /** - * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request should be the raw content of the new artifact version, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) + * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request can be the raw content of the new artifact version, or the raw content and a set of references pointing to other artifacts, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) * @summary Create artifact version * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. - * @param {any} body The content of the artifact version being created. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) + * @param {any} body The content of the artifact version being created or the content and a set of references to other artifacts. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) * @param {string} [xRegistryVersion] Specifies the version number of this new version of the artifact content. This would typically be a simple integer or a SemVer value. It must be unique within the artifact. If this is not provided, the server will generate a new, unique version number for this new updated content. * @param {string} [xRegistryName] Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content. * @param {string} [xRegistryDescription] Specifies the artifact description of this new version of the artifact content. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content. @@ -337,6 +402,19 @@ export const VersionsApiFactory = function (configuration?: Configuration, baseP createArtifactVersion(groupId: string, artifactId: string, body: any, xRegistryVersion?: string, xRegistryName?: string, xRegistryDescription?: string, xRegistryDescriptionEncoded?: string, xRegistryNameEncoded?: string, options?: any): AxiosPromise { return localVarFp.createArtifactVersion(groupId, artifactId, body, xRegistryVersion, xRegistryName, xRegistryDescription, xRegistryDescriptionEncoded, xRegistryNameEncoded, options).then((request) => request(axios, basePath)); }, + /** + * Retrieves a single version of the artifact content. Both the `artifactId` and the unique `version` number must be provided. The `Content-Type` of the response depends on the artifact type. In most cases, this is `application/json`, but for some types it may be different (for example, `PROTOBUF`). This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * No version with this `version` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get artifact version + * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. + * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {string} version The unique identifier of a specific version of the artifact content. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArtifactVersion(groupId: string, artifactId: string, version: string, dereference?: boolean, options?: any): AxiosPromise { + return localVarFp.getArtifactVersion(groupId, artifactId, version, dereference, options).then((request) => request(axios, basePath)); + }, /** * Retrieves a single version of the artifact content. Both the `artifactId` and the unique `version` number must be provided. The `Content-Type` of the response depends on the artifact type. In most cases, this is `application/json`, but for some types it may be different (for example, `PROTOBUF`). This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * No version with this `version` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact version @@ -346,8 +424,8 @@ export const VersionsApiFactory = function (configuration?: Configuration, baseP * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getArtifactVersion(groupId: string, artifactId: string, version: string, options?: any): AxiosPromise { - return localVarFp.getArtifactVersion(groupId, artifactId, version, options).then((request) => request(axios, basePath)); + getArtifactVersionReferences(groupId: string, artifactId: string, version: string, options?: any): AxiosPromise> { + return localVarFp.getArtifactVersionReferences(groupId, artifactId, version, options).then((request) => request(axios, basePath)); }, /** * Returns a list of all versions of the artifact. The result set is paged. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) @@ -385,11 +463,11 @@ export const VersionsApiFactory = function (configuration?: Configuration, baseP */ export interface VersionsApiInterface { /** - * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request should be the raw content of the new artifact version, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) + * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request can be the raw content of the new artifact version, or the raw content and a set of references pointing to other artifacts, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) * @summary Create artifact version * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. - * @param {any} body The content of the artifact version being created. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) + * @param {any} body The content of the artifact version being created or the content and a set of references to other artifacts. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) * @param {string} [xRegistryVersion] Specifies the version number of this new version of the artifact content. This would typically be a simple integer or a SemVer value. It must be unique within the artifact. If this is not provided, the server will generate a new, unique version number for this new updated content. * @param {string} [xRegistryName] Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content. * @param {string} [xRegistryDescription] Specifies the artifact description of this new version of the artifact content. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content. @@ -407,11 +485,24 @@ export interface VersionsApiInterface { * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. * @param {string} version The unique identifier of a specific version of the artifact content. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VersionsApiInterface */ - getArtifactVersion(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): AxiosPromise; + getArtifactVersion(groupId: string, artifactId: string, version: string, dereference?: boolean, options?: AxiosRequestConfig): AxiosPromise; + + /** + * Retrieves a single version of the artifact content. Both the `artifactId` and the unique `version` number must be provided. The `Content-Type` of the response depends on the artifact type. In most cases, this is `application/json`, but for some types it may be different (for example, `PROTOBUF`). This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * No version with this `version` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get artifact version + * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. + * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {string} version The unique identifier of a specific version of the artifact content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VersionsApiInterface + */ + getArtifactVersionReferences(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): AxiosPromise>; /** * Returns a list of all versions of the artifact. The result set is paged. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) @@ -449,11 +540,11 @@ export interface VersionsApiInterface { */ export class VersionsApi extends BaseAPI implements VersionsApiInterface { /** - * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request should be the raw content of the new artifact version, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) + * Creates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is added as the most recent version of the artifact. If any of the rules fail, an error is returned. The body of the request can be the raw content of the new artifact version, or the raw content and a set of references pointing to other artifacts, and the type of that content should match the artifact\'s type (for example if the artifact type is `AVRO` then the content of the request should be an Apache Avro document). This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with this `artifactId` exists (HTTP error `404`) * The new content violates one of the rules configured for the artifact (HTTP error `409`) * A server error occurred (HTTP error `500`) * @summary Create artifact version * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. - * @param {any} body The content of the artifact version being created. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) + * @param {any} body The content of the artifact version being created or the content and a set of references to other artifacts. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) * @param {string} [xRegistryVersion] Specifies the version number of this new version of the artifact content. This would typically be a simple integer or a SemVer value. It must be unique within the artifact. If this is not provided, the server will generate a new, unique version number for this new updated content. * @param {string} [xRegistryName] Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content. * @param {string} [xRegistryDescription] Specifies the artifact description of this new version of the artifact content. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content. @@ -467,6 +558,21 @@ export class VersionsApi extends BaseAPI implements VersionsApiInterface { return VersionsApiFp(this.configuration).createArtifactVersion(groupId, artifactId, body, xRegistryVersion, xRegistryName, xRegistryDescription, xRegistryDescriptionEncoded, xRegistryNameEncoded, options).then((request) => request(this.axios, this.basePath)); } + /** + * Retrieves a single version of the artifact content. Both the `artifactId` and the unique `version` number must be provided. The `Content-Type` of the response depends on the artifact type. In most cases, this is `application/json`, but for some types it may be different (for example, `PROTOBUF`). This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * No version with this `version` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) + * @summary Get artifact version + * @param {string} groupId The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. + * @param {string} artifactId The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. + * @param {string} version The unique identifier of a specific version of the artifact content. + * @param {boolean} [dereference] Allows the user to specify if the content should be dereferenced when being returned + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VersionsApi + */ + public getArtifactVersion(groupId: string, artifactId: string, version: string, dereference?: boolean, options?: AxiosRequestConfig) { + return VersionsApiFp(this.configuration).getArtifactVersion(groupId, artifactId, version, dereference, options).then((request) => request(this.axios, this.basePath)); + } + /** * Retrieves a single version of the artifact content. Both the `artifactId` and the unique `version` number must be provided. The `Content-Type` of the response depends on the artifact type. In most cases, this is `application/json`, but for some types it may be different (for example, `PROTOBUF`). This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * No version with this `version` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact version @@ -477,8 +583,8 @@ export class VersionsApi extends BaseAPI implements VersionsApiInterface { * @throws {RequiredError} * @memberof VersionsApi */ - public getArtifactVersion(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig) { - return VersionsApiFp(this.configuration).getArtifactVersion(groupId, artifactId, version, options).then((request) => request(this.axios, this.basePath)); + public getArtifactVersionReferences(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig) { + return VersionsApiFp(this.configuration).getArtifactVersionReferences(groupId, artifactId, version, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/packages/registry-instance-sdk/src/generated/base.ts b/packages/registry-instance-sdk/src/generated/base.ts index 8afab63f..8c54ec61 100644 --- a/packages/registry-instance-sdk/src/generated/base.ts +++ b/packages/registry-instance-sdk/src/generated/base.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/common.ts b/packages/registry-instance-sdk/src/generated/common.ts index a12c188b..580a5d5b 100644 --- a/packages/registry-instance-sdk/src/generated/common.ts +++ b/packages/registry-instance-sdk/src/generated/common.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/configuration.ts b/packages/registry-instance-sdk/src/generated/configuration.ts index c2dc045e..eea56bc8 100644 --- a/packages/registry-instance-sdk/src/generated/configuration.ts +++ b/packages/registry-instance-sdk/src/generated/configuration.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/index.ts b/packages/registry-instance-sdk/src/generated/index.ts index 63b10585..69c467ba 100644 --- a/packages/registry-instance-sdk/src/generated/index.ts +++ b/packages/registry-instance-sdk/src/generated/index.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/artifact-meta-data.ts b/packages/registry-instance-sdk/src/generated/model/artifact-meta-data.ts index 22ffe2ad..c999fdc6 100644 --- a/packages/registry-instance-sdk/src/generated/model/artifact-meta-data.ts +++ b/packages/registry-instance-sdk/src/generated/model/artifact-meta-data.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -13,6 +13,7 @@ */ +import { ArtifactReference } from './artifact-reference'; import { ArtifactState } from './artifact-state'; import { ArtifactType } from './artifact-type'; @@ -112,5 +113,11 @@ export interface ArtifactMetaData { * @memberof ArtifactMetaData */ 'contentId': number; + /** + * + * @type {Array} + * @memberof ArtifactMetaData + */ + 'references'?: Array; } diff --git a/packages/registry-instance-sdk/src/generated/model/artifact-reference.ts b/packages/registry-instance-sdk/src/generated/model/artifact-reference.ts new file mode 100644 index 00000000..48019446 --- /dev/null +++ b/packages/registry-instance-sdk/src/generated/model/artifact-reference.ts @@ -0,0 +1,48 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Apicurio Registry API [v2] + * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. + * + * The version of the OpenAPI document: 2.2.5.Final + * Contact: apicurio@lists.jboss.org + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * A reference to a different artifact. Typically used with artifact types that can have dependencies like Protobuf. + * @export + * @interface ArtifactReference + */ +export interface ArtifactReference { + /** + * + * @type {string} + * @memberof ArtifactReference + */ + 'groupId': string; + /** + * + * @type {string} + * @memberof ArtifactReference + */ + 'artifactId': string; + /** + * + * @type {string} + * @memberof ArtifactReference + */ + 'version'?: string; + /** + * + * @type {string} + * @memberof ArtifactReference + */ + 'name': string; +} + diff --git a/packages/registry-instance-sdk/src/generated/model/artifact-search-results.ts b/packages/registry-instance-sdk/src/generated/model/artifact-search-results.ts index 94e361c5..ca1cc71c 100644 --- a/packages/registry-instance-sdk/src/generated/model/artifact-search-results.ts +++ b/packages/registry-instance-sdk/src/generated/model/artifact-search-results.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/artifact-state.ts b/packages/registry-instance-sdk/src/generated/model/artifact-state.ts index e4779cba..75a36e7d 100644 --- a/packages/registry-instance-sdk/src/generated/model/artifact-state.ts +++ b/packages/registry-instance-sdk/src/generated/model/artifact-state.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/artifact-type.ts b/packages/registry-instance-sdk/src/generated/model/artifact-type.ts index e59a9d17..8038fb96 100644 --- a/packages/registry-instance-sdk/src/generated/model/artifact-type.ts +++ b/packages/registry-instance-sdk/src/generated/model/artifact-type.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/configuration-property.ts b/packages/registry-instance-sdk/src/generated/model/configuration-property.ts new file mode 100644 index 00000000..8dfa724a --- /dev/null +++ b/packages/registry-instance-sdk/src/generated/model/configuration-property.ts @@ -0,0 +1,54 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Apicurio Registry API [v2] + * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. + * + * The version of the OpenAPI document: 2.2.5.Final + * Contact: apicurio@lists.jboss.org + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface ConfigurationProperty + */ +export interface ConfigurationProperty { + /** + * + * @type {string} + * @memberof ConfigurationProperty + */ + 'name': string; + /** + * + * @type {string} + * @memberof ConfigurationProperty + */ + 'value': string; + /** + * + * @type {string} + * @memberof ConfigurationProperty + */ + 'type': string; + /** + * + * @type {string} + * @memberof ConfigurationProperty + */ + 'label': string; + /** + * + * @type {string} + * @memberof ConfigurationProperty + */ + 'description': string; +} + diff --git a/packages/registry-instance-sdk/src/generated/model/content-create-request.ts b/packages/registry-instance-sdk/src/generated/model/content-create-request.ts new file mode 100644 index 00000000..69974aca --- /dev/null +++ b/packages/registry-instance-sdk/src/generated/model/content-create-request.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Apicurio Registry API [v2] + * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. + * + * The version of the OpenAPI document: 2.2.5.Final + * Contact: apicurio@lists.jboss.org + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import { ArtifactReference } from './artifact-reference'; + +/** + * + * @export + * @interface ContentCreateRequest + */ +export interface ContentCreateRequest { + /** + * Raw content of the artifact. + * @type {string} + * @memberof ContentCreateRequest + */ + 'content': string; + /** + * Collection of references to other artifacts. + * @type {Array} + * @memberof ContentCreateRequest + */ + 'references': Array; +} + diff --git a/packages/registry-instance-sdk/src/generated/model/download-ref.ts b/packages/registry-instance-sdk/src/generated/model/download-ref.ts new file mode 100644 index 00000000..d5f8c2c0 --- /dev/null +++ b/packages/registry-instance-sdk/src/generated/model/download-ref.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Apicurio Registry API [v2] + * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. + * + * The version of the OpenAPI document: 2.2.5.Final + * Contact: apicurio@lists.jboss.org + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * Models a download \"link\". Useful for browser use-cases. + * @export + * @interface DownloadRef + */ +export interface DownloadRef { + /** + * + * @type {string} + * @memberof DownloadRef + */ + 'downloadId': string; + /** + * + * @type {string} + * @memberof DownloadRef + */ + 'href'?: string; +} + diff --git a/packages/registry-instance-sdk/src/generated/model/editable-meta-data.ts b/packages/registry-instance-sdk/src/generated/model/editable-meta-data.ts index ecd40e34..1f3b1745 100644 --- a/packages/registry-instance-sdk/src/generated/model/editable-meta-data.ts +++ b/packages/registry-instance-sdk/src/generated/model/editable-meta-data.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/if-exists.ts b/packages/registry-instance-sdk/src/generated/model/if-exists.ts index d17e5105..82907fae 100644 --- a/packages/registry-instance-sdk/src/generated/model/if-exists.ts +++ b/packages/registry-instance-sdk/src/generated/model/if-exists.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/index.ts b/packages/registry-instance-sdk/src/generated/model/index.ts index f2d0ef52..4f5b5f70 100644 --- a/packages/registry-instance-sdk/src/generated/model/index.ts +++ b/packages/registry-instance-sdk/src/generated/model/index.ts @@ -1,9 +1,14 @@ export * from './artifact-meta-data'; +export * from './artifact-reference'; export * from './artifact-search-results'; export * from './artifact-state'; export * from './artifact-type'; +export * from './configuration-property'; +export * from './content-create-request'; +export * from './download-ref'; export * from './editable-meta-data'; export * from './if-exists'; +export * from './limits'; export * from './log-configuration'; export * from './log-level'; export * from './model-error'; @@ -21,6 +26,7 @@ export * from './searched-version'; export * from './sort-by'; export * from './sort-order'; export * from './system-info'; +export * from './update-configuration-property'; export * from './update-role'; export * from './update-state'; export * from './user-info'; diff --git a/packages/registry-instance-sdk/src/generated/model/limits.ts b/packages/registry-instance-sdk/src/generated/model/limits.ts new file mode 100644 index 00000000..514e6bf8 --- /dev/null +++ b/packages/registry-instance-sdk/src/generated/model/limits.ts @@ -0,0 +1,96 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Apicurio Registry API [v2] + * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. + * + * The version of the OpenAPI document: 2.2.5.Final + * Contact: apicurio@lists.jboss.org + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * List of limitations on used resources, that are applied on the current instance of Registry. Keys represent the resource type and are suffixed by the corresponding unit. Values are integers. Only non-negative values are allowed, with the exception of -1, which means that the limit is not applied. + * @export + * @interface Limits + */ +export interface Limits { + /** + * + * @type {number} + * @memberof Limits + */ + 'maxTotalSchemasCount'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxSchemaSizeBytes'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxArtifactsCount'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxVersionsPerArtifactCount'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxArtifactPropertiesCount'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxPropertyKeySizeBytes'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxPropertyValueSizeBytes'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxArtifactLabelsCount'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxLabelSizeBytes'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxArtifactNameLengthChars'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxArtifactDescriptionLengthChars'?: number; + /** + * + * @type {number} + * @memberof Limits + */ + 'maxRequestsPerSecondCount'?: number; +} + diff --git a/packages/registry-instance-sdk/src/generated/model/log-configuration.ts b/packages/registry-instance-sdk/src/generated/model/log-configuration.ts index ad9d5f28..743749c0 100644 --- a/packages/registry-instance-sdk/src/generated/model/log-configuration.ts +++ b/packages/registry-instance-sdk/src/generated/model/log-configuration.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/log-level.ts b/packages/registry-instance-sdk/src/generated/model/log-level.ts index 3359d548..45500832 100644 --- a/packages/registry-instance-sdk/src/generated/model/log-level.ts +++ b/packages/registry-instance-sdk/src/generated/model/log-level.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/model-error.ts b/packages/registry-instance-sdk/src/generated/model/model-error.ts index df76f40b..6ae664e0 100644 --- a/packages/registry-instance-sdk/src/generated/model/model-error.ts +++ b/packages/registry-instance-sdk/src/generated/model/model-error.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/named-log-configuration-all-of.ts b/packages/registry-instance-sdk/src/generated/model/named-log-configuration-all-of.ts index 12cde49d..ec14f4b1 100644 --- a/packages/registry-instance-sdk/src/generated/model/named-log-configuration-all-of.ts +++ b/packages/registry-instance-sdk/src/generated/model/named-log-configuration-all-of.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/named-log-configuration.ts b/packages/registry-instance-sdk/src/generated/model/named-log-configuration.ts index 04dc9429..fd5731ef 100644 --- a/packages/registry-instance-sdk/src/generated/model/named-log-configuration.ts +++ b/packages/registry-instance-sdk/src/generated/model/named-log-configuration.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/role-mapping.ts b/packages/registry-instance-sdk/src/generated/model/role-mapping.ts index 2e3c0c24..b712f80d 100644 --- a/packages/registry-instance-sdk/src/generated/model/role-mapping.ts +++ b/packages/registry-instance-sdk/src/generated/model/role-mapping.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -33,5 +33,11 @@ export interface RoleMapping { * @memberof RoleMapping */ 'role': RoleType; + /** + * A friendly name for the principal. + * @type {string} + * @memberof RoleMapping + */ + 'principalName'?: string; } diff --git a/packages/registry-instance-sdk/src/generated/model/role-type.ts b/packages/registry-instance-sdk/src/generated/model/role-type.ts index 31026a46..0bd7e629 100644 --- a/packages/registry-instance-sdk/src/generated/model/role-type.ts +++ b/packages/registry-instance-sdk/src/generated/model/role-type.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/rule-type.ts b/packages/registry-instance-sdk/src/generated/model/rule-type.ts index b3994f00..98411975 100644 --- a/packages/registry-instance-sdk/src/generated/model/rule-type.ts +++ b/packages/registry-instance-sdk/src/generated/model/rule-type.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/rule-violation-cause.ts b/packages/registry-instance-sdk/src/generated/model/rule-violation-cause.ts index a286110f..ad570c3b 100644 --- a/packages/registry-instance-sdk/src/generated/model/rule-violation-cause.ts +++ b/packages/registry-instance-sdk/src/generated/model/rule-violation-cause.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/rule-violation-error-all-of.ts b/packages/registry-instance-sdk/src/generated/model/rule-violation-error-all-of.ts index cc7e55b0..e882bc41 100644 --- a/packages/registry-instance-sdk/src/generated/model/rule-violation-error-all-of.ts +++ b/packages/registry-instance-sdk/src/generated/model/rule-violation-error-all-of.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/rule-violation-error.ts b/packages/registry-instance-sdk/src/generated/model/rule-violation-error.ts index da2694b6..4cbba4eb 100644 --- a/packages/registry-instance-sdk/src/generated/model/rule-violation-error.ts +++ b/packages/registry-instance-sdk/src/generated/model/rule-violation-error.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/rule.ts b/packages/registry-instance-sdk/src/generated/model/rule.ts index 5d6ccf98..52b20799 100644 --- a/packages/registry-instance-sdk/src/generated/model/rule.ts +++ b/packages/registry-instance-sdk/src/generated/model/rule.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/searched-artifact.ts b/packages/registry-instance-sdk/src/generated/model/searched-artifact.ts index cd3a3b59..a24cca83 100644 --- a/packages/registry-instance-sdk/src/generated/model/searched-artifact.ts +++ b/packages/registry-instance-sdk/src/generated/model/searched-artifact.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/searched-version.ts b/packages/registry-instance-sdk/src/generated/model/searched-version.ts index 6e0cbf1d..152e5774 100644 --- a/packages/registry-instance-sdk/src/generated/model/searched-version.ts +++ b/packages/registry-instance-sdk/src/generated/model/searched-version.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -13,6 +13,7 @@ */ +import { ArtifactReference } from './artifact-reference'; import { ArtifactState } from './artifact-state'; import { ArtifactType } from './artifact-type'; @@ -88,5 +89,11 @@ export interface SearchedVersion { * @memberof SearchedVersion */ 'contentId': number; + /** + * + * @type {Array} + * @memberof SearchedVersion + */ + 'references': Array; } diff --git a/packages/registry-instance-sdk/src/generated/model/sort-by.ts b/packages/registry-instance-sdk/src/generated/model/sort-by.ts index f5718503..b75897b7 100644 --- a/packages/registry-instance-sdk/src/generated/model/sort-by.ts +++ b/packages/registry-instance-sdk/src/generated/model/sort-by.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/sort-order.ts b/packages/registry-instance-sdk/src/generated/model/sort-order.ts index 89bf1560..a8724bd9 100644 --- a/packages/registry-instance-sdk/src/generated/model/sort-order.ts +++ b/packages/registry-instance-sdk/src/generated/model/sort-order.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/system-info.ts b/packages/registry-instance-sdk/src/generated/model/system-info.ts index 83f1e2b8..3819f006 100644 --- a/packages/registry-instance-sdk/src/generated/model/system-info.ts +++ b/packages/registry-instance-sdk/src/generated/model/system-info.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/update-configuration-property.ts b/packages/registry-instance-sdk/src/generated/model/update-configuration-property.ts new file mode 100644 index 00000000..3a6a6bcb --- /dev/null +++ b/packages/registry-instance-sdk/src/generated/model/update-configuration-property.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Apicurio Registry API [v2] + * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. + * + * The version of the OpenAPI document: 2.2.5.Final + * Contact: apicurio@lists.jboss.org + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface UpdateConfigurationProperty + */ +export interface UpdateConfigurationProperty { + /** + * + * @type {string} + * @memberof UpdateConfigurationProperty + */ + 'value': string; +} + diff --git a/packages/registry-instance-sdk/src/generated/model/update-role.ts b/packages/registry-instance-sdk/src/generated/model/update-role.ts index 5e5baa30..e9031b2d 100644 --- a/packages/registry-instance-sdk/src/generated/model/update-role.ts +++ b/packages/registry-instance-sdk/src/generated/model/update-role.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/update-state.ts b/packages/registry-instance-sdk/src/generated/model/update-state.ts index 6c2cf0cd..6d15c2c2 100644 --- a/packages/registry-instance-sdk/src/generated/model/update-state.ts +++ b/packages/registry-instance-sdk/src/generated/model/update-state.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/user-info.ts b/packages/registry-instance-sdk/src/generated/model/user-info.ts index 8e01473a..c03085a0 100644 --- a/packages/registry-instance-sdk/src/generated/model/user-info.ts +++ b/packages/registry-instance-sdk/src/generated/model/user-info.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/version-meta-data.ts b/packages/registry-instance-sdk/src/generated/model/version-meta-data.ts index 546d88ef..5c44a442 100644 --- a/packages/registry-instance-sdk/src/generated/model/version-meta-data.ts +++ b/packages/registry-instance-sdk/src/generated/model/version-meta-data.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/registry-instance-sdk/src/generated/model/version-search-results.ts b/packages/registry-instance-sdk/src/generated/model/version-search-results.ts index fed8568c..8b3410c4 100644 --- a/packages/registry-instance-sdk/src/generated/model/version-search-results.ts +++ b/packages/registry-instance-sdk/src/generated/model/version-search-results.ts @@ -4,7 +4,7 @@ * Apicurio Registry API [v2] * Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: - Apache Avro schema - AsyncAPI specification - Google protocol buffers - GraphQL schema - JSON Schema - Kafka Connect schema - OpenAPI specification - Web Services Description Language - XML Schema Definition **Important**: The Apicurio Registry REST API is available from `https://MY-REGISTRY-URL/apis/registry/v2` by default. Therefore you must prefix all API operation paths with `../apis/registry/v2` in this case. For example: `../apis/registry/v2/ids/globalIds/{globalId}`. * - * The version of the OpenAPI document: 2.1.0-SNAPSHOT + * The version of the OpenAPI document: 2.2.5.Final * Contact: apicurio@lists.jboss.org * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).