update-datahub-dataset

restish dci update-datahub-dataset name

Updates an existing DataHub dataset's metadata. Only the description field can be updated. The dataset name is immutable and serves as the resource identifier. To rename a dataset, delete it and create a new one. If name is included in the request body, it must match the dataset name in the URL path. A mismatched name will be rejected with a 400 error.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "Must match the dataset name in the URL path. Included for idempotency; the name cannot be changed.",
      "example": "My Custom Dataset"
    },
    "description": {
      "type": "string",
      "description": "The new description for the dataset.",
      "example": "Updated description for the dataset"
    }
  }
}

Responses

200 (application/json)

OK - Dataset updated successfully.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the dataset.",
      "example": "My Custom Dataset"
    },
    "description": {
      "type": "string",
      "description": "The description of the dataset.",
      "example": "Updated description for the dataset"
    },
    "records": {
      "type": "integer",
      "format": "int64",
      "description": "The number of records in the dataset.",
      "example": 1500,
      "nullable": true
    },
    "updatedBy": {
      "type": "string",
      "description": "The email of the user who last updated the dataset.",
      "example": "[email protected]"
    },
    "lastUpdated": {
      "type": "string",
      "description": "The timestamp of the last update.",
      "example": "2024-03-10T23:00:00Z"
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: update-datahub-dataset, updatedatahubdataset