{ "opencollection": "1.0.0", "info": { "name": "Apicurio Registry Admin Metadata API", "version": "3.1.x" }, "items": [ { "info": { "name": "Metadata", "type": "folder" }, "items": [ { "info": { "name": "Get artifact version metadata", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8080/apis/registry/v3/groups/:groupId/artifacts/:artifactId/versions/:versionExpression", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. Must follow the \".{1,512}\" pattern." }, { "name": "artifactId", "value": "", "type": "path", "description": "The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. Must follow the \".{1,512}\" pattern." }, { "name": "versionExpression", "value": "", "type": "path", "description": "An expression resolvable to a specific version ID within the given group and artifact. The following rules apply:\n\n - If the expression is in the form \"branch={branchId}\", and artifact branch {branchId} exists: The expression is resolved to a version that the branch points to.\n - Otherwise: The expression is resolved to a version with the same ID, which must follow the \"[a-zA-Z0-9._\\\\-+]{1,256}\" pattern." } ] }, "docs": "Retrieves the metadata for a single version of the artifact. The version metadata is \na subset of the artifact metadata and only includes the metadata that is specific to\nthe version (for example, this doesn't include `modifiedOn`).\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n" }, { "info": { "name": "Update artifact version metadata", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8080/apis/registry/v3/groups/:groupId/artifacts/:artifactId/versions/:versionExpression", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. Must follow the \".{1,512}\" pattern." }, { "name": "artifactId", "value": "", "type": "path", "description": "The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. Must follow the \".{1,512}\" pattern." }, { "name": "versionExpression", "value": "", "type": "path", "description": "An expression resolvable to a specific version ID within the given group and artifact. The following rules apply:\n\n - If the expression is in the form \"branch={branchId}\", and artifact branch {branchId} exists: The expression is resolved to a version that the branch points to.\n - Otherwise: The expression is resolved to a version with the same ID, which must follow the \"[a-zA-Z0-9._\\\\-+]{1,256}\" pattern." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the user-editable portion of the artifact version's metadata. Only some of \nthe metadata fields are editable by the user. For example, `description` is editable, \nbut `createdOn` is not.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n" }, { "info": { "name": "Get artifact metadata", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8080/apis/registry/v3/groups/:groupId/artifacts/:artifactId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. Must follow the \".{1,512}\" pattern." }, { "name": "artifactId", "value": "", "type": "path", "description": "The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. Must follow the \".{1,512}\" pattern." } ] }, "docs": "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`" }, { "info": { "name": "Update artifact metadata", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8080/apis/registry/v3/groups/:groupId/artifacts/:artifactId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. Must follow the \".{1,512}\" pattern." }, { "name": "artifactId", "value": "", "type": "path", "description": "The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier. Must follow the \".{1,512}\" pattern." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the editable parts of the artifact's metadata. Not all metadata fields can\nbe updated. Note that only the properties included will be updated. You can update\nonly the name by including only the `name` property in the payload of the request.\nProperties that are allowed but not present will result in the artifact's metadata\nnot being changed.\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" } ] } ], "bundled": true }