openapi-directory/api/apicurio.local/registry.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.2","servers":[{"url":"http://apicurio.local"}],"info":{"contact":{"email":"apicurio@lists.jboss.org","name":"Apicurio","url":"https://github.com/apicurio/apicurio-registry"},"description":"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.\n\nThe 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. \n\nThe supported artifact types include:\n- Apache Avro schema\n- AsyncAPI specification\n- Google protocol buffers\n- GraphQL schema\n- JSON Schema\n- Kafka Connect schema\n- OpenAPI specification\n- Web Services Description Language\n- XML Schema Definition\n\n\n**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}`.\n","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"title":"Apicurio Registry API [v2]","version":"2.4.x","x-apisguru-categories":["developer_tools"],"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/Apicurio/apicurio-registry/master/app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json","version":"3.0"}],"x-preferred":true,"x-providerName":"apicurio.local","x-serviceName":"registry"},"tags":[{"description":"The primary way to interact with the Apicurio Registry API is to add, update, \nor delete artifacts. This section includes all of these primary operations.","name":"Artifacts"},{"description":"Sometimes the metadata for an artifact is important. For example, metadata includes \nwhen the artifact was created, last updated, and so on. This section contains \noperations to access (and in some cases change) an artifact's metadata.","name":"Metadata"},{"description":"When artifact content is updated, old versions of the artifact content are not lost.  All versions can be listed and accessed if necessary. This section describes the operations used to list and access all versions of an artifact's content and metadata.","name":"Versions"},{"description":"Rules can be configured on a per-artifact basis, allowing for different approaches\nto content evolution for each artifact.  These rules override any global rules\nthat have been configured. This section contains the operations used to manage a\nsingle artifact's rules.","name":"Artifact rules"},{"description":"Global rules can be configured in the registry to govern how artifact content can \nevolve over time (as artifact content is **updated**). Global rules are applied \nwhenever an artifact is added to the registry, and also whenever an artifact's \ncontent is updated (only if that artifact does not have its own specific rules \nconfigured). This section describes the operations used to manage the global rules.","name":"Global rules"},{"description":"The search API is used to browse or find artifacts in the registry. This section describes the operations for searching for artifacts and versions. ","name":"Search"},{"description":"Application functionality that is only accessible to admin users.  Includes logging, global rules, and export/import of registry data.","name":"Admin"},{"description":"System level functionality, including versioning and status information.","name":"System"},{"description":"Operations related to users.","name":"Users"},{"description":"Registry artifacts can be collected together using groups. This section includes all of the primary operations related to groups.","name":"Groups"}],"paths":{"/admin/artifactTypes":{"get":{"description":"Gets a list of all the configured artifact types.\n\nThis operation can fail for the following reasons:\n\n* A server error occurred (HTTP error `500`)\n","operationId":"listArtifactTypes","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ArtifactTypeInfo"},"type":"array"}}},"description":"The list of available artifact types."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List artifact types","tags":["Artifact Type","Admin"]},"summary":"The list of artifact types supported by this instance of Registry."},"/admin/config/properties":{"get":{"description":"Returns a list of all configuration properties that have been set.  The list is not paged.\n\nThis operation may fail for one of the following reasons:\n\n* A server error occurred (HTTP error `500`)\n","operationId":"listConfigProperties","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ConfigurationProperty"},"type":"array"}}},"description":"On a successful response, returns a list of configuration properties."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List all configuration properties","tags":["Admin"]},"summary":"Manage configuration properties."},"/admin/config/properties/{propertyName}":{"delete":{"description":"Resets the value of a single configuration property.  This will return the property to\nits default value (see external documentation for supported properties and their default\nvalues).\n\nThis operation may fail for one of the following reasons:\n\n* Property not found or not configured (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"resetConfigProperty","responses":{"204":{"description":"The configuration property was deleted."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Reset a configuration property","tags":["Admin"]},"get":{"description":"Returns the value of a single configuration property.\n\nThis operation may fail for one of the following reasons:\n\n* Property not found or not configured (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"getConfigProperty","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationProperty"}}},"description":"The configuration property value."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get configuration property value","tags":["Admin"]},"parameters":[{"description":"The name of a configuration property.","in":"path","name":"propertyName","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates the value of a single configuration property.\n\nThis operation may fail for one of the following reasons:\n\n* Property not found or not configured (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"updateConfigProperty","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConfigurationProperty"}}},"required":true},"responses":{"204":{"description":"The configuration property was updated."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update a configuration property","tags":["Admin"]},"summary":"Manage a single configuration property (by name)."},"/admin/export":{"get":{"description":"Exports registry data as a ZIP archive.","operationId":"exportData","parameters":[{"description":"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.","in":"query","name":"forBrowser","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadRef"}},"application/zip":{"schema":{"$ref":"#/components/schemas/FileContent"}}},"description":"Response when the export is successful."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Export registry data","tags":["Admin"]},"summary":"Provides a way to export registry data."},"/admin/import":{"post":{"description":"Imports registry data that was previously exported using the `/admin/export` operation.","operationId":"importData","parameters":[{"description":"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.","in":"header","name":"X-Registry-Preserve-GlobalId","schema":{"type":"boolean"}},{"description":"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.","in":"header","name":"X-Registry-Preserve-ContentId","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/zip":{"schema":{"$ref":"#/components/schemas/FileContent"}}},"description":"The ZIP file representing the previously exported registry data.","required":true},"responses":{"201":{"description":"Indicates that the import was successful."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Import registry data","tags":["Admin"]},"summary":"Provides a way to import data into the registry."},"/admin/loggers":{"get":{"description":"List all of the configured logging levels.  These override the default\nlogging configuration.","operationId":"listLogConfigurations","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NamedLogConfiguration"},"type":"array"}}},"description":"The list of logging configurations."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List logging configurations","tags":["Admin"]},"summary":"Manage logger settings/configurations."},"/admin/loggers/{logger}":{"delete":{"description":"Removes the configured logger configuration (if any) for the given logger.","operationId":"removeLogConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamedLogConfiguration"}}},"description":"The default logger configuration (now that the configuration for this logger has been removed, the \ndefault configuration is applied)."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Removes logger configuration","tags":["Admin"]},"get":{"description":"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.","operationId":"getLogConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamedLogConfiguration"}}},"description":"The logger configuration for the named logger."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get a single logger configuration","tags":["Admin"]},"parameters":[{"description":"The name of a single logger.","in":"path","name":"logger","required":true,"schema":{"type":"string"}}],"put":{"description":"Configures the logger referenced by the provided logger name with the given configuration.","operationId":"setLogConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogConfiguration"}}},"description":"The new logger configuration.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamedLogConfiguration"}}},"description":"The new configuration for the given logger."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Set a logger's configuration","tags":["Admin"]},"summary":"Manage logger settings/configurations."},"/admin/roleMappings":{"get":{"description":"Gets a list of all role mappings configured in the registry (if any).\n\nThis operation can fail for the following reasons:\n\n* A server error occurred (HTTP error `500`)\n","operationId":"listRoleMappings","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleMapping"},"type":"array"}}},"description":"A successful response will return the list of role mappings."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List all role mappings","tags":["Admin"]},"post":{"description":"Creates a new mapping between a user/principal and a role.\n\nThis operation can fail for the following reasons:\n\n* A server error occurred (HTTP error `500`)\n\n","operationId":"createRoleMapping","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleMapping"}}},"required":true},"responses":{"204":{"description":"Returned when the role mapping was successfully created."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create a new role mapping","tags":["Admin"]},"summary":"Collection to manage role mappings for authenticated principals"},"/admin/roleMappings/{principalId}":{"delete":{"description":"Deletes a single role mapping, effectively denying access to a user/principal.\n\nThis operation can fail for the following reasons:\n\n* No role mapping for the principalId exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"deleteRoleMapping","responses":{"204":{"description":"Response returned when the delete was successful."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete a role mapping","tags":["Admin"]},"get":{"description":"Gets the details of a single role mapping (by `principalId`).\n\nThis operation can fail for the following reasons:\n\n* No role mapping for the `principalId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"getRoleMapping","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleMapping"}}},"description":"When successful, returns the details of a role mapping."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Return a single role mapping","tags":["Admin"]},"parameters":[{"description":"Unique id of a principal (typically either a user or service account).","in":"path","name":"principalId","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates a single role mapping for one user/principal.\n\nThis operation can fail for the following reasons:\n\n* No role mapping for the principalId exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"updateRoleMapping","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRole"}}},"required":true},"responses":{"204":{"description":"Response when the update is successful."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update a role mapping","tags":["Admin"]},"summary":"Manage the configuration of a single role mapping."},"/admin/rules":{"delete":{"description":"Deletes all globally configured rules.\n\nThis operation can fail for the following reasons:\n\n* A server error occurred (HTTP error `500`)\n","operationId":"deleteAllGlobalRules","responses":{"204":{"description":"All global rules have been removed successfully."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete all global rules","tags":["Global rules","Admin"]},"get":{"description":"Gets a list of all the currently configured global rules (if any).\n\nThis operation can fail for the following reasons:\n\n* A server error occurred (HTTP error `500`)\n","operationId":"listGlobalRules","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RuleType"},"type":"array"}}},"description":"The list of names of the globally configured rules."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List global rules","tags":["Global rules","Admin"]},"post":{"description":"Adds a rule to the list of globally configured rules.\n\nThis operation can fail for the following reasons:\n\n* The rule type is unknown (HTTP error `400`)\n* The rule already exists (HTTP error `409`)\n* A server error occurred (HTTP error `500`)\n","operationId":"createGlobalRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"required":true},"responses":{"204":{"description":"The global rule was added."},"400":{"$ref":"#/components/responses/BadRequest"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create global rule","tags":["Global rules","Admin"]},"summary":"Manage the global rules that apply to all artifacts if not otherwise configured."},"/admin/rules/{rule}":{"delete":{"description":"Deletes a single global rule.  If this is the only rule configured, this is the same\nas deleting **all** rules.\n\nThis operation can fail for the following reasons:\n\n* Invalid rule name/type (HTTP error `400`)\n* No rule with name/type `rule` exists (HTTP error `404`)\n* Rule cannot be deleted (HTTP error `409`)\n* A server error occurred (HTTP error `500`)\n","operationId":"deleteGlobalRule","responses":{"204":{"description":"The global rule was successfully deleted."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete global rule","tags":["Global rules","Admin"]},"get":{"description":"Returns information about the named globally configured rule.\n\nThis operation can fail for the following reasons:\n\n* Invalid rule name/type (HTTP error `400`)\n* No rule with name/type `rule` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"getGlobalRuleConfig","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"description":"The global rule's configuration."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get global rule configuration","tags":["Global rules","Admin"]},"parameters":[{"description":"The unique name/type of a rule.","in":"path","name":"rule","required":true,"schema":{"$ref":"#/components/schemas/RuleType"}}],"put":{"description":"Updates the configuration for a globally configured rule.\n\nThis operation can fail for the following reasons:\n\n* Invalid rule name/type (HTTP error `400`)\n* No rule with name/type `rule` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"updateGlobalRuleConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"description":"The global rule's configuration was successfully updated."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update global rule configuration","tags":["Global rules","Admin"]},"summary":"Manage the configuration of a single global artifact rule."},"/groups":{"get":{"description":"Returns a list of all groups.  This list is paged.","operationId":"listGroups","parameters":[{"description":"The number of groups to return.  Defaults to 20.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"The number of groups to skip before starting the result set.  Defaults to 0.","in":"query","name":"offset","schema":{"type":"integer"}},{"description":"Sort order, ascending (`asc`) or descending (`desc`).","in":"query","name":"order","schema":{"$ref":"#/components/schemas/SortOrder"}},{"description":"The field to sort by.  Can be one of:\n\n* `name`\n* `createdOn`\n","in":"query","name":"orderby","schema":{"$ref":"#/components/schemas/SortBy"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSearchResults"}}},"description":"On a successful response, returns a bounded set of groups."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List groups","tags":["Groups"]},"post":{"description":"Creates a new group.\n\nThis operation can fail for the following reasons:\n\n* A server error occurred (HTTP error `500`)\n* The group already exist (HTTP error `409`)\n","operationId":"createGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupMetaData"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMetaData"}}},"description":"The group has been successfully created."},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create a new group","tags":["Groups"]},"summary":"Collection of the groups in the registry."},"/groups/{groupId}":{"delete":{"description":"Deletes a group by identifier.\n\nThis operation can fail for the following reasons:\n\n* A server error occurred (HTTP error `500`)\n* The group does not exist (HTTP error `404`)\n","operationId":"deleteGroupById","responses":{"204":{"description":"Empty content indicates a successful deletion."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete a group by the specified ID.","tags":["Groups"]},"get":{"description":"Returns a group using the specified id.\n\nThis operation can fail for the following reasons:\n\n* No group exists with the specified ID (HTTP error `404`)\n* A server error occurred (HTTP error `500`)","operationId":"getGroupById","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMetaData"}}},"description":"The group's metadata."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get a group by the specified ID.","tags":["Groups"]},"parameters":[{"description":"The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.","in":"path","name":"groupId","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}}],"summary":"Collection to manage a single group in the registry."},"/groups/{groupId}/artifacts":{"delete":{"description":"Deletes all of the artifacts that exist in a given group.","operationId":"deleteArtifactsInGroup","responses":{"204":{"description":"When the delete operation is successful, a simple 204 is returned."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete artifacts in group","tags":["Artifacts"]},"get":{"description":"Returns a list of all artifacts in the group.  This list is paged.","operationId":"listArtifactsInGroup","parameters":[{"description":"The number of artifacts to return.  Defaults to 20.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"The number of artifacts to skip before starting the result set.  Defaults to 0.","in":"query","name":"offset","schema":{"type":"integer"}},{"description":"Sort order, ascending (`asc`) or descending (`desc`).","in":"query","name":"order","schema":{"$ref":"#/components/schemas/SortOrder"}},{"description":"The field to sort by.  Can be one of:\n\n* `name`\n* `createdOn`\n","in":"query","name":"orderby","schema":{"$ref":"#/components/schemas/SortBy"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArtifactSearchResults"}}},"description":"On a successful response, returns a bounded set of artifacts."},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List artifacts in group","tags":["Artifacts"]},"parameters":[{"description":"The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.","in":"path","name":"groupId","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}}],"post":{"description":"Creates a new artifact by posting the artifact content.  The body of the request should\nbe the raw content of the artifact.  This is typically in JSON format for *most* of the \nsupported types, but may be in another format for a few (for example, `PROTOBUF`).\n\nThe registry attempts to figure out what kind of artifact is being added from the\nfollowing supported list:\n\n* Avro (`AVRO`)\n* Protobuf (`PROTOBUF`)\n* JSON Schema (`JSON`)\n* Kafka Connect (`KCONNECT`)\n* OpenAPI (`OPENAPI`)\n* AsyncAPI (`ASYNCAPI`)\n* GraphQL (`GRAPHQL`)\n* Web Services Description Language (`WSDL`)\n* XML Schema (`XSD`)\n\nAlternatively, you can specify the artifact type using the `X-Registry-ArtifactType` \nHTTP request header, or include a hint in the request's `Content-Type`.  For example:\n\n```\nContent-Type: application/json; artifactType=AVRO\n```\n\nAn artifact is created using the content provided in the body of the request.  This\ncontent is created under a unique artifact ID that can be provided in the request\nusing the `X-Registry-ArtifactId` request header.  If not provided in the request,\nthe server generates a unique ID for the artifact.  It is typically recommended\nthat callers provide the ID, because this is typically a meaningful identifier, \nand for most use cases should be supplied by the caller.\n\nIf an artifact with the provided artifact ID already exists, the default behavior\nis for the server to reject the content with a 409 error.  However, the caller can\nsupply the `ifExists` query parameter to alter this default behavior. The `ifExists`\nquery parameter can have one of the following values:\n\n* `FAIL` (*default*) - server rejects the content with a 409 error\n* `UPDATE` - server updates the existing artifact and returns the new metadata\n* `RETURN` - server does not create or add content to the server, but instead \nreturns the metadata for the existing artifact\n* `RETURN_OR_UPDATE` - server returns an existing **version** that matches the \nprovided content if such a version exists, otherwise a new version is created\n\nThis operation may fail for one of the following reasons:\n\n* An invalid `ArtifactType` was indicated (HTTP error `400`)\n* No `ArtifactType` was indicated and the server could not determine one from the content (HTTP error `400`)\n* Provided content (request body) was empty (HTTP error `400`)\n* An artifact with the provided ID already exists (HTTP error `409`)\n* The content violates one of the configured global rules (HTTP error `409`)\n* A server error occurred (HTTP error `500`)\n","operationId":"createArtifact","parameters":[{"description":"Specifies the type of the artifact being added. Possible values include:\n\n* Avro (`AVRO`)\n* Protobuf (`PROTOBUF`)\n* JSON Schema (`JSON`)\n* Kafka Connect (`KCONNECT`)\n* OpenAPI (`OPENAPI`)\n* AsyncAPI (`ASYNCAPI`)\n* GraphQL (`GRAPHQL`)\n* Web Services Description Language (`WSDL`)\n* XML Schema (`XSD`)","in":"header","name":"X-Registry-ArtifactType","schema":{"$ref":"#/components/schemas/ArtifactType"}},{"description":"A client-provided, globally unique identifier for the new artifact.","in":"header","name":"X-Registry-ArtifactId","schema":{"type":"string"}},{"description":"Specifies the version number of this initial version of the artifact content.  This would typically\nbe a simple integer or a SemVer value.  If not provided, the server will assign a version number\nautomatically (starting with version `1`).","in":"header","name":"X-Registry-Version","schema":{"$ref":"#/components/schemas/Version"}},{"description":"Set this option to instruct the server on what to do if the artifact already exists.","in":"query","name":"ifExists","schema":{"$ref":"#/components/schemas/IfExists"}},{"description":"Used only when the `ifExists` query parameter is set to `RETURN_OR_UPDATE`, this parameter can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for a matching version.  The canonicalization algorithm is unique to each artifact type, but typically involves removing extra whitespace and formatting the content in a consistent manner.","in":"query","name":"canonical","schema":{"type":"boolean"}},{"description":"Specifies the description of artifact being added. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content.","in":"header","name":"X-Registry-Description","required":false,"schema":{"$ref":"#/components/schemas/ArtifactDescription"}},{"description":"Specifies the description of artifact being added. Value of this must be Base64 encoded string. If this is not provided, the server will extract the description from the artifact content.","in":"header","name":"X-Registry-Description-Encoded","schema":{"$ref":"#/components/schemas/EncodedArtifactDescription"}},{"description":"Specifies the name of artifact being added. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content.","in":"header","name":"X-Registry-Name","schema":{"$ref":"#/components/schemas/ArtifactName"}},{"description":"Specifies the name of artifact being added. Value of this must be Base64 encoded string. If this is not provided, the server will extract the name from the artifact content.","in":"header","name":"X-Registry-Name-Encoded","schema":{"$ref":"#/components/schemas/EncodedArtifactName"}},{"description":"Specifies the (optional) hash of the artifact to be verified.","in":"header","name":"X-Registry-Content-Hash","schema":{"type":"string"}},{"description":"The algorithm to use when checking the content validity. (available: SHA256, MD5; default: SHA256)","in":"header","name":"X-Registry-Hash-Algorithm","schema":{"enum":["SHA256","MD5"],"type":"string"}}],"requestBody":{"content":{"*/*":{"examples":{"OpenAPI Example":{"value":{"components":{"schemas":{"Widget":{"description":"A sample data type.","example":{"property-1":"value1","property-2":true},"properties":{"property-1":{"type":"string"},"property-2":{"type":"boolean"}},"title":"Root Type for Widget","type":"object"}}},"info":{"description":"An example API design using OpenAPI.","title":"Empty API","version":"1.0.7"},"openapi":"3.0.2","paths":{"/widgets":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"All widgets"}},"summary":"Get widgets"}}}}}},"schema":{"$ref":"#/components/schemas/FileContent"}},"application/create.extended+json":{"schema":{"$ref":"#/components/schemas/ArtifactContent"}},"application/vnd.create.extended+json":{"schema":{"$ref":"#/components/schemas/ArtifactContent"}}},"description":"The content of the artifact being created. This is often, but not always, JSON data\nrepresenting one of the supported artifact types:\n\n* Avro (`AVRO`)\n* Protobuf (`PROTOBUF`)\n* JSON Schema (`JSON`)\n* Kafka Connect (`KCONNECT`)\n* OpenAPI (`OPENAPI`)\n* AsyncAPI (`ASYNCAPI`)\n* GraphQL (`GRAPHQL`)\n* Web Services Description Language (`WSDL`)\n* XML Schema (`XSD`)\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArtifactMetaData"}}},"description":"Artifact was successfully created."},"400":{"$ref":"#/components/responses/BadRequest"},"409":{"$ref":"#/components/responses/RuleViolationConflict"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create artifact","tags":["Artifacts"]},"summary":"Manage the collection of artifacts within a single group in the registry."},"/groups/{groupId}/artifacts/{artifactId}":{"delete":{"description":"Deletes an artifact completely, resulting in all versions of the artifact also being\ndeleted.  This may fail for one of the following reasons:\n\n* No artifact with the `artifactId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)","operationId":"deleteArtifact","responses":{"204":{"description":"Returned when the artifact was successfully deleted."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete artifact","tags":["Artifacts"]},"get":{"description":"Returns the latest version of the artifact in its raw form.  The `Content-Type` of the\nresponse depends on the artifact type.  In most cases, this is `application/json`, but \nfor some types it may be different (for example, `PROTOBUF`).\nIf the latest version of the artifact is marked as `DISABLED`, the next available non-disabled version will be used.\n\nThis operation may fail for one of the following reasons:\n\n* No artifact with this `artifactId` exists or all versions are `DISABLED` (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"getLatestArtifact","parameters":[{"description":"Allows the user to specify if the content should be dereferenced when being returned","in":"query","name":"dereference","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/ArtifactContent"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get latest artifact","tags":["Artifacts"]},"parameters":[{"description":"The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.","in":"path","name":"groupId","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}},{"description":"The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.","in":"path","name":"artifactId","required":true,"schema":{"$ref":"#/components/schemas/ArtifactId"}}],"put":{"description":"Updates an artifact by uploading new content.  The body of the request can\nbe the raw content of the artifact or a JSON object containing both the raw content and\na set of references to other artifacts..  This is typically in JSON format for *most*\nof the supported types, but may be in another format for a few (for example, `PROTOBUF`).\nThe type of the content should be compatible with the artifact's type (it would be\nan error to update an `AVRO` artifact with new `OPENAPI` content, for example).\n\nThe update could fail for a number of reasons including:\n\n* Provided content (request body) was empty (HTTP error `400`)\n* No artifact with the `artifactId` exists (HTTP error `404`)\n* The new content violates one of the rules configured for the artifact (HTTP error `409`)\n* A server error occurred (HTTP error `500`)\n\nWhen successful, this creates a new version of the artifact, making it the most recent\n(and therefore official) version of the artifact.","operationId":"updateArtifact","parameters":[{"description":"Specifies the version number of this new version of the artifact content.  This would typically\nbe a simple integer or a SemVer value.  If not provided, the server will assign a version number\nautomatically.","in":"header","name":"X-Registry-Version","schema":{"$ref":"#/components/schemas/Version"}},{"description":"Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not\nprovided, the server will extract the name from the artifact content.","in":"header","name":"X-Registry-Name","schema":{"$ref":"#/components/schemas/ArtifactName"}},{"description":"Specifies the artifact name of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the name from the artifact content.","in":"header","name":"X-Registry-Name-Encoded","schema":{"$ref":"#/components/schemas/EncodedArtifactName"}},{"description":"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.","in":"header","name":"X-Registry-Description","schema":{"$ref":"#/components/schemas/ArtifactDescription"}},{"description":"Specifies the artifact description of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the description from the artifact content.","in":"header","name":"X-Registry-Description-Encoded","schema":{"$ref":"#/components/schemas/EncodedArtifactDescription"}}],"requestBody":{"content":{"*/*":{"examples":{"OpenAPI Example":{"value":{"components":{"schemas":{"Widget":{"description":"A sample data type.","example":{"property-1":"value1","property-2":true},"properties":{"property-1":{"type":"string"},"property-2":{"type":"boolean"}},"title":"Root Type for Widget","type":"object"}}},"info":{"description":"An example API design using OpenAPI.","title":"Empty API","version":"1.0.7"},"openapi":"3.0.2","paths":{"/widgets":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"All widgets"}},"summary":"Get widgets"}}}}}},"schema":{"$ref":"#/components/schemas/FileContent"}},"application/create.extended+json":{"schema":{"$ref":"#/components/schemas/ArtifactContent"}},"application/vnd.create.extended+json":{"schema":{"$ref":"#/components/schemas/ArtifactContent"}}},"description":"The new content of the artifact being updated. This is often, but not always, JSON data\nrepresenting one of the supported artifact types:\n\n* Avro (`AVRO`)\n* Protobuf (`PROTOBUF`)\n* JSON Schema (`JSON`)\n* Kafka Connect (`KCONNECT`)\n* OpenAPI (`OPENAPI`)\n* AsyncAPI (`ASYNCAPI`)\n* GraphQL (`GRAPHQL`)\n* Web Services Description Language (`WSDL`)\n* XML Schema (`XSD`)\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArtifactMetaData"}}},"description":"When successful, returns the updated artifact metadata."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update artifact","tags":["Artifacts"]},"summary":"Manage a single artifact."},"/groups/{groupId}/artifacts/{artifactId}/meta":{"get":{"description":"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\nboth generated (read-only) and editable metadata (such as name and description).\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists  or all versions are `DISABLED` (HTTP error `404`)\n* A server error occurred (HTTP error `500`)","operationId":"getArtifactMetaData","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArtifactMetaData"}}},"description":"The artifact's metadata."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get artifact metadata","tags":["Metadata"]},"parameters":[{"description":"The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.","in":"path","name":"groupId","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}},{"description":"The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.","in":"path","name":"artifactId","required":true,"schema":{"$ref":"#/components/schemas/ArtifactId"}}],"post":{"description":"Gets the metadata for an artifact that matches the raw content.  Searches the registry\nfor a version of the given artifact matching the content provided in the body of the\nPOST.\n\nThis operation can fail for the following reasons:\n\n* Provided content (request body) was empty (HTTP error `400`)\n* No artifact with the `artifactId` exists (HTTP error `404`)\n* No artifact version matching the provided content exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n","operationId":"getArtifactVersionMetaDataByContent","parameters":[{"description":"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.","in":"query","name":"canonical","schema":{"type":"boolean"}}],"requestBody":{"content":{"*/*":{"examples":{"OpenAPI":{"value":{"components":{"schemas":{"Widget":{"description":"A sample data type.","example":{"property-1":"value1","property-2":true},"properties":{"property-1":{"type":"string"},"property-2":{"type":"boolean"}},"title":"Root Type for Widget","type":"object"}}},"info":{"description":"An example API design using OpenAPI.","title":"Empty API","version":"1.0.7"},"openapi":"3.0.2","paths":{"/widgets":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"All widgets"}},"summary":"Get widgets"}}}}}},"schema":{"$ref":"#/components/schemas/FileContent"}},"application/get.extended+json":{"schema":{"$ref":"#/components/schemas/ArtifactContent"}},"application/vnd.get.extended+json":{"schema":{"$ref":"#/components/schemas/ArtifactContent"}}},"description":"The content of an artifact version.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionMetaData"}}},"description":"The metadata of the artifact version matching the provided content."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get artifact version metadata by content","tags":["Metadata"]},"put":{"description":"Updates the editable parts of the artifact's metadata.  Not all metadata fields can\nbe updated.  For example, `createdOn` and `createdBy` are both read-only properties.\n\nThis operation can fail for the following reasons:\n\n* No artifact with the `artifactId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)","operationId":"updateArtifactMetaData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditableMetaData"}}},"description":"Updated artifact metadata.","required":true},"responses":{"204":{"description":"The artifact's metadata was updated."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update artifact metadata","tags":["Metadata"]},"summary":"Manage the metadata of a single artifact."},"/groups/{groupId}/artifacts/{artifactId}/owner":{"get":{"description":"Gets the owner of an artifact in the registry.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)","operationId":"getArtifactOwner","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArtifactOwner"}}},"description":"The artifact's owner."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get artifact owner","tags":["Metadata"]},"parameters":[{"description":"The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.","in":"path","name":"groupId","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}},{"description":"The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.","in":"path","name":"artifactId","required":true,"schema":{"$ref":"#/components/schemas/ArtifactId"}}],"put":{"description":"Changes the ownership of an artifact.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)","operationId":"updateArtifactOwner","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArtifactOwner"}}},"required":true},"responses":{"204":{"description":"The owner was successfully changed."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update artifact owner","tags":["Metadata"]},"summary":"Manage the ownership of a single artifact."},"/groups/{groupId}/artifacts/{artifactId}/rules":{"delete":{"description":"Deletes all of the rules configured for the artifact.  After this is done, the global\nrules apply to the artifact again.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)","operationId":"deleteArtifactRules","responses":{"204":{"description":"The rules were successfully deleted."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete artifact rules","tags":["Artifact rules"]},"get":{"description":"Returns a list of all rules configured for the artifact.  The set of rules determines\nhow the content of an artifact can evolve over time.  If no rules are configured for\nan artifact, the set of globally configured rules are used.  If no global rules \nare defined, there are no restrictions on content evolution.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)","operationId":"listArtifactRules","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RuleType"},"type":"array"}}},"description":"Returns the names of the rules configured for the artifact."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List artifact rules","tags":["Artifact rules"]},"parameters":[{"description":"The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.","in":"path","name":"groupId","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}},{"description":"The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.","in":"path","name":"artifactId","required":true,"schema":{"$ref":"#/components/schemas/ArtifactId"}}],"post":{"description":"Adds a rule to the list of rules that get applied to the artifact when adding new\nversions.  All configured rules must pass to successfully add a new artifact version.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* Rule (named in the request body) is unknown (HTTP error `400`)\n* A server error occurred (HTTP error `500`)","operationId":"createArtifactRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"required":true},"responses":{"204":{"description":"The rule was added."},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create artifact rule","tags":["Artifact rules"]},"summary":"Manage the rules for a single artifact."},"/groups/{groupId}/artifacts/{artifactId}/rules/{rule}":{"delete":{"description":"Deletes a rule from the artifact.  This results in the rule no longer applying for\nthis artifact.  If this is the only rule configured for the artifact, this is the \nsame as deleting **all** rules, and the globally configured rules now apply to\nthis artifact.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No rule with this name/type is configured for this artifact (HTTP error `404`)\n* Invalid rule type (HTTP error `400`)\n* A server error occurred (HTTP error `500`)","operationId":"deleteArtifactRule","responses":{"204":{"description":"The rule was successfully deleted."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete artifact rule","tags":["Artifact rules"]},"get":{"description":"Returns information about a single rule configured for an artifact.  This is useful\nwhen you want to know what the current configuration settings are for a specific rule.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No rule with this name/type is configured for this artifact (HTTP error `404`)\n* Invalid rule type (HTTP error `400`)\n* A server error occurred (HTTP error `500`)","operationId":"getArtifactRuleConfig","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"description":"Information about a rule."},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get artifact rule configuration","tags":["Artifact rules"]},"parameters":[{"description":"The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.","in":"path","name":"groupId","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}},{"description":"The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.","in":"path","name":"artifactId","required":true,"schema":{"$ref":"#/components/schemas/ArtifactId"}},{"description":"The unique name/ty