---
title: "Update the UI schema for a definition"
method: PUT
path: "/api/v1/definitions/{definitionName}/uischema"
tags: ["definition"]
---

# Update the UI schema for a definition

`PUT /api/v1/definitions/{definitionName}/uischema`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/kubevela/apis/kubevela-api-doc/docs/api/v1/definitions/:definitionName/uischema/put.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `definitionName` string, required

## Request body

- V1UpdateUISchemaRequest
  - `type` string, required
  - `uiSchema` SchemaUIParameter[], required
    - `additional` boolean
    - `additionalParameter` SchemaUIParameter (recursive)
    - `conditions` SchemaCondition[]
      - `action` string
      - `jsonKey` string, required
      - `op` string
      - `value` unknown, required
    - `description` string, required
    - `disable` boolean
    - `jsonKey` string, required
    - `label` string, required
    - `sort` integer, required
    - `style` SchemaStyle
      - `colSpan` integer, required
    - `subParameterGroupOption` SchemaGroupOption[]
      - `keys` string[], required
      - `label` string, required
    - `subParameters` SchemaUIParameter[]
    - `uiType` string, required
    - `validate` SchemaValidate
      - `defaultValue` unknown
      - `immutable` boolean, required
      - `max` number, double
      - `maxLength` integer
      - `min` number, double
      - `minLength` integer
      - `options` SchemaOption[]
        - `label` string, required
        - `value` unknown, required
      - `pattern` string
      - `required` boolean

## Response `200`

update successfully

- SchemaUIParameter[]
  - unknown

## Other responses

- `500`: Bummer, something went wrong

## Changes

- **2023-03-21** `68bb06fccf44`: 1 breaking
  - added the new path request parameter `definitionName`
- **2023-03-09** `a0cc5d422c34`: 1 warning
  - deleted the `path` request parameter `definitionName`

[Operation history](https://skmtc.dev/kubevela/apis/kubevela-api-doc/changes/api/v1/definitions/:definitionName/uischema/put.md)

---

[API](https://skmtc.dev/kubevela/apis/kubevela-api-doc.md) - [All operations](https://skmtc.dev/kubevela/apis/kubevela-api-doc/llms.txt) - [OpenAPI document](https://skmtc.dev/kubevela/apis/kubevela-api-doc/revisions/f2cd6d5cf4c6?raw)