Update artifact

v1.0.0

Updates an artifact by uploading new content. The body of the request can be the raw content of the artifact or a JSON object containing both the raw content and a set of references to other artifacts.. This is typically in JSON format for most of the supported types, but may be in another format for a few (for example, PROTOBUF). The type of the content should be compatible with the artifact's type (it would be an error to update an AVRO artifact with new OPENAPI content, for example).

The update could fail for a number of reasons including:

Provided content (request body) was empty (HTTP error 400)
No artifact with the artifactId exists (HTTP error 404)
The new content violates one of the rules configured for the artifact (HTTP error 409)
A server error occurred (HTTP error 500)

When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact.

Input

{
  "type": "object",
  "properties": {
    "X-Registry-Description": {
      "type": "string",
      "description": "Description of the artifact."
    },
    "X-Registry-Description-Encoded": {
      "type": "string",
      "description": "Base64 encoded description of the artifact."
    },
    "X-Registry-Name": {
      "type": "string",
      "description": "Name of the artifact."
    },
    "X-Registry-Name-Encoded": {
      "type": "string",
      "description": "Base64 encoded name of the artifact."
    },
    "X-Registry-Version": {
      "type": "string",
      "description": "A single version of an artifact.  Can be provided by the client when creating a new version,\nor it can be server-generated.  The value can be any string unique to the artifact, but it is\nrecommended to use a simple integer or a semver value."
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "contentId",
    "createdBy",
    "createdOn",
    "globalId",
    "group",
    "id",
    "modifiedBy",
    "modifiedOn",
    "state",
    "type",
    "version"
  ],
  "properties": {
    "contentId": {
      "type": "integer",
      "format": "int64"
    },
    "createdBy": {
      "type": "string"
    },
    "createdOn": {
      "type": "string",
      "format": "date-time"
    },
    "description": {
      "type": "string"
    },
    "globalId": {
      "type": "integer",
      "format": "int64"
    },
    "groupId": {
      "type": "string",
      "description": "An ID of a single artifact group."
    },
    "id": {
      "type": "string"
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "modifiedBy": {
      "type": "string"
    },
    "modifiedOn": {
      "type": "string",
      "format": "date-time"
    },
    "name": {
      "type": "string"
    },
    "properties": {
      "type": "object"
    },
    "references": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A reference to a different artifact. Typically used with artifact types that can have dependencies like Protobuf.",
        "required": [
          "artifactId",
          "groupId",
          "name"
        ],
        "properties": {
          "artifactId": {
            "type": "string"
          },
          "groupId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "version": {
            "type": "string"
          }
        }
      }
    },
    "state": {
      "type": "string",
      "enum": [
        "ENABLED",
        "DISABLED",
        "DEPRECATED"
      ]
    },
    "type": {
      "type": "string"
    },
    "version": {
      "type": "string"
    }
  }
}