Skip to content

update_model

Update model metadata, settings with replacement semantics, and anonymous access policy.

auth_required is not (anonymous_access.read and anonymous_access.create). settings replaces the stored settings object: send the complete merged object, or a key you omit (such as consumer_reads) is removed. A metadata-only update leaves settings unchanged.

settings.consumer_reads decides what a signed-in consumer of this application may read on a private model: any_authenticated grants every eligible row, even when consumer_owner_query is also set; owner grants only the rows the consumer_owner_query saved query returns for the consumer and is rejected without that query; absent or off keep the legacy behavior (an owner query still scopes the consumer to its rows, otherwise no private rows). Anonymous callers are governed only by anonymous_access.read. consumer_reads never grants writes or actions; consumer_writes and public_record_actions stay separate required checks.

{
"additionalProperties": false,
"properties": {
"anonymous_create": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Anonymous Create"
},
"anonymous_read": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Anonymous Read"
},
"application_id": {
"title": "Application Id",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"idempotency_key": {
"title": "Idempotency Key",
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Label"
},
"model_id": {
"title": "Model Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"plural_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Plural Label"
},
"settings": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Settings"
}
},
"required": [
"application_id",
"model_id",
"idempotency_key"
],
"title": "update_modelArguments",
"type": "object"
}
{
"description": "Schema for model detail responses including fields.",
"properties": {
"applicationId": {
"format": "uuid",
"title": "Applicationid",
"type": "string"
},
"createdAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"draftDiffersFromPublished": {
"default": false,
"title": "Draftdiffersfrompublished",
"type": "boolean"
},
"draftSchemaVersion": {
"title": "Draftschemaversion",
"type": "integer"
},
"fields": {
"items": {
"description": "Schema for field data in responses.",
"properties": {
"createdAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"defaultValue": {
"title": "Defaultvalue"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"isRequired": {
"title": "Isrequired",
"type": "boolean"
},
"isUnique": {
"title": "Isunique",
"type": "boolean"
},
"label": {
"title": "Label",
"type": "string"
},
"modelId": {
"format": "uuid",
"title": "Modelid",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"position": {
"title": "Position",
"type": "integer"
},
"settings": {
"additionalProperties": true,
"title": "Settings",
"type": "object"
},
"tenantId": {
"format": "uuid",
"title": "Tenantid",
"type": "string"
},
"type": {
"title": "Type",
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Updatedat"
},
"workspaceId": {
"format": "uuid",
"title": "Workspaceid",
"type": "string"
}
},
"required": [
"id",
"tenantId",
"workspaceId",
"modelId",
"name",
"label",
"type",
"isRequired",
"isUnique",
"position"
],
"title": "FieldResponse",
"type": "object"
},
"title": "Fields",
"type": "array"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Icon"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"pluralLabel": {
"title": "Plurallabel",
"type": "string"
},
"publishedSchemaVersion": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Publishedschemaversion"
},
"schemaState": {
"title": "Schemastate",
"type": "string"
},
"settings": {
"additionalProperties": true,
"title": "Settings",
"type": "object"
},
"tenantId": {
"format": "uuid",
"title": "Tenantid",
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Updatedat"
},
"workspaceId": {
"format": "uuid",
"title": "Workspaceid",
"type": "string"
}
},
"required": [
"id",
"tenantId",
"workspaceId",
"applicationId",
"name",
"label",
"pluralLabel",
"schemaState",
"draftSchemaVersion"
],
"title": "ModelDetailResponse",
"type": "object"
}