Skip to content
Omniglass Omniglass Omniglass

Update a component

PATCH
/components/{name}
 
curl --request PATCH \
  --url https://example.com/api/v1/components/example \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "name": "example" }'

Patches a component’s technical name or display_name. Gated by component:update; read and update scopes drive the 404 versus 403 split.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
display_name
string
name

A new globally unique technical name (rename)

string
>= 1 characters <= 100 characters /^[a-z0-9][a-z0-9-]*$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
actions

The scope-aware actions the caller may perform on this row (create a child, update, delete); a UI hint, the server still enforces.

Array<string> | null
display_name
string
effective_tags

The resolved effective tags (key -> winning value) that cascade onto this component; for the Tags column. Provenance is in the effective-tags detail view.

object
key
additional properties
string
id
required
string
location

The location’s name, for display

string
location_id

The location’s id, the canonical handle

string
name
required
string
parent

The parent component’s name, for display; absent for a root component

string
parent_id

The parent component’s id, the canonical handle

string
product

The product’s name, for display; the form a body round-trips.

string
product_id

The product (catalog SKU) this component is an instance of, if any; the stable handle that survives a rename.

string
system

Name of the component’s primary system, its default when no system is named. A component may belong to several; read /components/{name}/memberships for all of them.

string
system_count
required

How many systems this component belongs to; more than one means it is shared.

integer format: int64
system_id

The primary system’s id, the canonical handle

string
Example 
{
  "$schema": "/api/v1/schemas/ComponentBody.json"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}