v1

latestOpenAPI 3.1.02026-07-13154170539.0 KB

Logs

Update Field

Updates an existing field.

For now this is intentionally metadata-only and only supports updating the field description. It does not modify log payloads, derived templates, field names, mutability, or data types.

patch/v0/logs/update_field

Request body

project_namestring required

Name of the project the field belongs to.

contextstring nullable

The context of the field to update.

field_namestring required

The name of the field to update.

descriptionstring nullable required

Field description. This is the only supported field update. Use null to clear the description.

Example request

{
  "project_name": "eval-project",
  "context": "test-context",
  "field_name": "score",
  "description": "Human-readable score for this log entry"
}

Response

Field updated successfully

{"stackTrail":"paths:/v0/logs/update_field:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}