/** * 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.4.x * 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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { ArtifactMetaData } from '../model'; import { ArtifactOwner } from '../model'; import { EditableMetaData } from '../model'; import { VersionMetaData } from '../model'; /** * MetadataApi - axios parameter creator * @export */ export declare const MetadataApiAxiosParamCreator: (configuration?: Configuration) => { /** * Deletes the user-editable metadata properties of the artifact version. Any properties that are not user-editable are preserved. 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 Delete artifact version metadata * @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} */ deleteArtifactVersionMetaData: (groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig) => Promise; /** * Gets the metadata for an artifact in the registry, based on the latest version. If the latest version of the artifact is marked as `DISABLED`, the next available non-disabled version will be used. The returned metadata includes both generated (read-only) and editable metadata (such as name and description). This operation can fail for the following reasons: * No artifact with this `artifactId` exists or all versions are `DISABLED` (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact metadata * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getArtifactMetaData: (groupId: string, artifactId: string, options?: AxiosRequestConfig) => Promise; /** * Gets the owner of an artifact in the registry. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact owner * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getArtifactOwner: (groupId: string, artifactId: string, options?: AxiosRequestConfig) => Promise; /** * Retrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is specific to the version (for example, this doesn\'t include `modifiedOn`). 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 metadata * @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} */ getArtifactVersionMetaData: (groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig) => Promise; /** * Gets the metadata for an artifact that matches the raw content. Searches the registry for a version of the given artifact matching the content provided in the body of the POST. This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * No artifact version matching the provided content exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact version metadata by content * @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 an artifact version. * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for a matching version. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getArtifactVersionMetaDataByContent: (groupId: string, artifactId: string, body: any, canonical?: boolean, options?: AxiosRequestConfig) => Promise; /** * Updates the editable parts of the artifact\'s metadata. Not all metadata fields can be updated. For example, `createdOn` and `createdBy` are both read-only properties. This operation can fail for the following reasons: * No artifact with the `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact metadata * @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 {EditableMetaData} editableMetaData Updated artifact metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArtifactMetaData: (groupId: string, artifactId: string, editableMetaData: EditableMetaData, options?: AxiosRequestConfig) => Promise; /** * Changes the ownership of an artifact. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact owner * @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 {ArtifactOwner} artifactOwner * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArtifactOwner: (groupId: string, artifactId: string, artifactOwner: ArtifactOwner, options?: AxiosRequestConfig) => Promise; /** * Updates the user-editable portion of the artifact version\'s metadata. Only some of the metadata fields are editable by the user. For example, `description` is editable, but `createdOn` is not. 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 Update artifact version metadata * @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 {EditableMetaData} editableMetaData * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArtifactVersionMetaData: (groupId: string, artifactId: string, version: string, editableMetaData: EditableMetaData, options?: AxiosRequestConfig) => Promise; }; /** * MetadataApi - functional programming interface * @export */ export declare const MetadataApiFp: (configuration?: Configuration) => { /** * Deletes the user-editable metadata properties of the artifact version. Any properties that are not user-editable are preserved. 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 Delete artifact version metadata * @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} */ deleteArtifactVersionMetaData(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the metadata for an artifact in the registry, based on the latest version. If the latest version of the artifact is marked as `DISABLED`, the next available non-disabled version will be used. The returned metadata includes both generated (read-only) and editable metadata (such as name and description). This operation can fail for the following reasons: * No artifact with this `artifactId` exists or all versions are `DISABLED` (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact metadata * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getArtifactMetaData(groupId: string, artifactId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the owner of an artifact in the registry. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact owner * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getArtifactOwner(groupId: string, artifactId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is specific to the version (for example, this doesn\'t include `modifiedOn`). 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 metadata * @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} */ getArtifactVersionMetaData(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the metadata for an artifact that matches the raw content. Searches the registry for a version of the given artifact matching the content provided in the body of the POST. This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * No artifact version matching the provided content exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact version metadata by content * @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 an artifact version. * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for a matching version. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getArtifactVersionMetaDataByContent(groupId: string, artifactId: string, body: any, canonical?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the editable parts of the artifact\'s metadata. Not all metadata fields can be updated. For example, `createdOn` and `createdBy` are both read-only properties. This operation can fail for the following reasons: * No artifact with the `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact metadata * @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 {EditableMetaData} editableMetaData Updated artifact metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArtifactMetaData(groupId: string, artifactId: string, editableMetaData: EditableMetaData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Changes the ownership of an artifact. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact owner * @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 {ArtifactOwner} artifactOwner * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArtifactOwner(groupId: string, artifactId: string, artifactOwner: ArtifactOwner, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the user-editable portion of the artifact version\'s metadata. Only some of the metadata fields are editable by the user. For example, `description` is editable, but `createdOn` is not. 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 Update artifact version metadata * @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 {EditableMetaData} editableMetaData * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArtifactVersionMetaData(groupId: string, artifactId: string, version: string, editableMetaData: EditableMetaData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MetadataApi - factory interface * @export */ export declare const MetadataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Deletes the user-editable metadata properties of the artifact version. Any properties that are not user-editable are preserved. 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 Delete artifact version metadata * @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} */ deleteArtifactVersionMetaData(groupId: string, artifactId: string, version: string, options?: any): AxiosPromise; /** * Gets the metadata for an artifact in the registry, based on the latest version. If the latest version of the artifact is marked as `DISABLED`, the next available non-disabled version will be used. The returned metadata includes both generated (read-only) and editable metadata (such as name and description). This operation can fail for the following reasons: * No artifact with this `artifactId` exists or all versions are `DISABLED` (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact metadata * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getArtifactMetaData(groupId: string, artifactId: string, options?: any): AxiosPromise; /** * Gets the owner of an artifact in the registry. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact owner * @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 {*} [options] Override http request option. * @throws {RequiredError} */ getArtifactOwner(groupId: string, artifactId: string, options?: any): AxiosPromise; /** * Retrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is specific to the version (for example, this doesn\'t include `modifiedOn`). 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 metadata * @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} */ getArtifactVersionMetaData(groupId: string, artifactId: string, version: string, options?: any): AxiosPromise; /** * Gets the metadata for an artifact that matches the raw content. Searches the registry for a version of the given artifact matching the content provided in the body of the POST. This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * No artifact version matching the provided content exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact version metadata by content * @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 an artifact version. * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for a matching version. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getArtifactVersionMetaDataByContent(groupId: string, artifactId: string, body: any, canonical?: boolean, options?: any): AxiosPromise; /** * Updates the editable parts of the artifact\'s metadata. Not all metadata fields can be updated. For example, `createdOn` and `createdBy` are both read-only properties. This operation can fail for the following reasons: * No artifact with the `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact metadata * @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 {EditableMetaData} editableMetaData Updated artifact metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArtifactMetaData(groupId: string, artifactId: string, editableMetaData: EditableMetaData, options?: any): AxiosPromise; /** * Changes the ownership of an artifact. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact owner * @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 {ArtifactOwner} artifactOwner * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArtifactOwner(groupId: string, artifactId: string, artifactOwner: ArtifactOwner, options?: any): AxiosPromise; /** * Updates the user-editable portion of the artifact version\'s metadata. Only some of the metadata fields are editable by the user. For example, `description` is editable, but `createdOn` is not. 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 Update artifact version metadata * @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 {EditableMetaData} editableMetaData * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArtifactVersionMetaData(groupId: string, artifactId: string, version: string, editableMetaData: EditableMetaData, options?: any): AxiosPromise; }; /** * MetadataApi - interface * @export * @interface MetadataApi */ export interface MetadataApiInterface { /** * Deletes the user-editable metadata properties of the artifact version. Any properties that are not user-editable are preserved. 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 Delete artifact version metadata * @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 MetadataApiInterface */ deleteArtifactVersionMetaData(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): AxiosPromise; /** * Gets the metadata for an artifact in the registry, based on the latest version. If the latest version of the artifact is marked as `DISABLED`, the next available non-disabled version will be used. The returned metadata includes both generated (read-only) and editable metadata (such as name and description). This operation can fail for the following reasons: * No artifact with this `artifactId` exists or all versions are `DISABLED` (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact metadata * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApiInterface */ getArtifactMetaData(groupId: string, artifactId: string, options?: AxiosRequestConfig): AxiosPromise; /** * Gets the owner of an artifact in the registry. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact owner * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApiInterface */ getArtifactOwner(groupId: string, artifactId: string, options?: AxiosRequestConfig): AxiosPromise; /** * Retrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is specific to the version (for example, this doesn\'t include `modifiedOn`). 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 metadata * @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 MetadataApiInterface */ getArtifactVersionMetaData(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): AxiosPromise; /** * Gets the metadata for an artifact that matches the raw content. Searches the registry for a version of the given artifact matching the content provided in the body of the POST. This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * No artifact version matching the provided content exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact version metadata by content * @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 an artifact version. * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for a matching version. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApiInterface */ getArtifactVersionMetaDataByContent(groupId: string, artifactId: string, body: any, canonical?: boolean, options?: AxiosRequestConfig): AxiosPromise; /** * Updates the editable parts of the artifact\'s metadata. Not all metadata fields can be updated. For example, `createdOn` and `createdBy` are both read-only properties. This operation can fail for the following reasons: * No artifact with the `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact metadata * @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 {EditableMetaData} editableMetaData Updated artifact metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApiInterface */ updateArtifactMetaData(groupId: string, artifactId: string, editableMetaData: EditableMetaData, options?: AxiosRequestConfig): AxiosPromise; /** * Changes the ownership of an artifact. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact owner * @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 {ArtifactOwner} artifactOwner * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApiInterface */ updateArtifactOwner(groupId: string, artifactId: string, artifactOwner: ArtifactOwner, options?: AxiosRequestConfig): AxiosPromise; /** * Updates the user-editable portion of the artifact version\'s metadata. Only some of the metadata fields are editable by the user. For example, `description` is editable, but `createdOn` is not. 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 Update artifact version metadata * @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 {EditableMetaData} editableMetaData * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApiInterface */ updateArtifactVersionMetaData(groupId: string, artifactId: string, version: string, editableMetaData: EditableMetaData, options?: AxiosRequestConfig): AxiosPromise; } /** * MetadataApi - object-oriented interface * @export * @class MetadataApi * @extends {BaseAPI} */ export declare class MetadataApi extends BaseAPI implements MetadataApiInterface { /** * Deletes the user-editable metadata properties of the artifact version. Any properties that are not user-editable are preserved. 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 Delete artifact version metadata * @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 MetadataApi */ deleteArtifactVersionMetaData(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): Promise>; /** * Gets the metadata for an artifact in the registry, based on the latest version. If the latest version of the artifact is marked as `DISABLED`, the next available non-disabled version will be used. The returned metadata includes both generated (read-only) and editable metadata (such as name and description). This operation can fail for the following reasons: * No artifact with this `artifactId` exists or all versions are `DISABLED` (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact metadata * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApi */ getArtifactMetaData(groupId: string, artifactId: string, options?: AxiosRequestConfig): Promise>; /** * Gets the owner of an artifact in the registry. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact owner * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApi */ getArtifactOwner(groupId: string, artifactId: string, options?: AxiosRequestConfig): Promise>; /** * Retrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is specific to the version (for example, this doesn\'t include `modifiedOn`). 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 metadata * @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 MetadataApi */ getArtifactVersionMetaData(groupId: string, artifactId: string, version: string, options?: AxiosRequestConfig): Promise>; /** * Gets the metadata for an artifact that matches the raw content. Searches the registry for a version of the given artifact matching the content provided in the body of the POST. This operation can fail for the following reasons: * Provided content (request body) was empty (HTTP error `400`) * No artifact with the `artifactId` exists (HTTP error `404`) * No artifact version matching the provided content exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Get artifact version metadata by content * @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 an artifact version. * @param {boolean} [canonical] Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for a matching version. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApi */ getArtifactVersionMetaDataByContent(groupId: string, artifactId: string, body: any, canonical?: boolean, options?: AxiosRequestConfig): Promise>; /** * Updates the editable parts of the artifact\'s metadata. Not all metadata fields can be updated. For example, `createdOn` and `createdBy` are both read-only properties. This operation can fail for the following reasons: * No artifact with the `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact metadata * @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 {EditableMetaData} editableMetaData Updated artifact metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApi */ updateArtifactMetaData(groupId: string, artifactId: string, editableMetaData: EditableMetaData, options?: AxiosRequestConfig): Promise>; /** * Changes the ownership of an artifact. This operation can fail for the following reasons: * No artifact with this `artifactId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`) * @summary Update artifact owner * @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 {ArtifactOwner} artifactOwner * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApi */ updateArtifactOwner(groupId: string, artifactId: string, artifactOwner: ArtifactOwner, options?: AxiosRequestConfig): Promise>; /** * Updates the user-editable portion of the artifact version\'s metadata. Only some of the metadata fields are editable by the user. For example, `description` is editable, but `createdOn` is not. 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 Update artifact version metadata * @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 {EditableMetaData} editableMetaData * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataApi */ updateArtifactVersionMetaData(groupId: string, artifactId: string, version: string, editableMetaData: EditableMetaData, options?: AxiosRequestConfig): Promise>; }