Update model version

PUT 
/metalakes/:metalake/catalogs/:catalog/schemas/:schema/models/:model/versions

Update model version

Request

Path Parameters

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

schema stringrequired

The name of the schema

model stringrequired

The name of the model

application/json

Body

updates

object[]

required

Array [

oneOf

UpdateModelVersionCommentRequest

@type stringrequired

Possible values: [updateComment]

newComment stringrequired

The new comment of the model version

SetModelVersionPropertyRequest

@type stringrequired

Possible values: [setProperty]

The type of the update

property stringrequired

The name of the property to set

value stringrequired

The value of the property to set

RemoveModelVersionPropertyRequest

@type stringrequired

Possible values: [removeProperty]

The type of the update

property stringrequired

The property to remove

UpdateModelVersionUriRequest

@type stringrequired

Possible values: [updateUri]

newUri stringrequired

The new uri of the model version

]

Responses

200

The response of model version object

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

modelVersion

object

uri stringrequired

The uri of the model version

version integerrequired

The version of the model

aliases string[]nullable

The aliases of the model version

comment stringnullable

The comment of the model version

properties

object

nullable

The properties of the model version

property name* string

audit

object

required

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

Example (from schema)

{
  "code": 0,
  "modelVersion": {
    "uri": "string",
    "version": 0,
    "aliases": [
      "string"
    ],
    "comment": "string",
    "properties": {},
    "audit": {
      "creator": "string",
      "createTime": "2024-07-29T15:51:28.071Z",
      "lastModifier": "string",
      "lastModifiedTime": "2024-07-29T15:51:28.071Z"
    }
  }
}

ModelResponse

{
  "code": 0,
  "modelVersion": {
    "uri": "hdfs://path/to/model",
    "version": 0,
    "aliases": [
      "alias1",
      "alias2"
    ],
    "comment": "This is a comment",
    "properties": {
      "key1": "value1",
      "key2": "value2"
    },
    "audit": {
      "creator": "user1",
      "createTime": "2021-01-01T00:00:00Z",
      "lastModifier": "user1",
      "lastModifiedTime": "2021-01-01T00:00:00Z"
    }
  }
}

400

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

{
  "code": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

404

Not Found - The target model or model version does not exist

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

NoSuchModelException

{
  "code": 1003,
  "type": "NoSuchModelException",
  "message": "Model does not exist",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchModelException: Model does not exist"
  ]
}

NoSuchModelVersionException

{
  "code": 1003,
  "type": "NoSuchModelVersionException",
  "message": "Model version does not exist",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchModelVersionException: Model version does not exist"
  ]
}

5xx

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...