dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Content Type Field API

37 actions 37 updates phrasing extends openapi/dotcms-content-type-field-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for dotCMS's API. It is a proposal applied on top of the contract, not a document dotCMS publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 37 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v1/fieldTypes'].get
$.paths['/api/v1/contenttype/{typeId}/fields'].get
$.paths['/api/v1/contenttype/{typeId}/fields'].put
$.paths['/api/v1/contenttype/{typeId}/fields'].post
$.paths['/api/v1/contenttype/{typeId}/fields'].delete
$.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}'].get
$.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}'].put
$.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}'].delete
$.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}'].get
$.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}'].put
$.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}'].delete
$.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables'].get
$.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables'].post
$.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables'].get
$.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for dotCMS REST Content Type Field API
  version: 1.0.0
extends: openapi/dotcms-content-type-field-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 36
- target: $.paths['/api/v1/fieldTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List available field types
      effect: read
      questions:
      - What kinds of fields can I add to a content type in dotCMS?
      - Which field types are available when configuring a content type?
      instructions:
      - text: List every field type I can use when building a content type.
      - text: Show me the catalog of available content type field types.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List a content type's fields (deprecated v1)
      effect: read
      questions:
      - How do I get all fields of a content type through the old v1 fields endpoint?
      - Can the deprecated v1 API still list a content type's fields by its type ID?
      instructions:
      - text: Using the deprecated v1 endpoint, list all fields of content type {typeId}.
        slots:
          typeId: path.typeId
      - text: Fetch the v1 field list for content type ID {typeId}.
        slots:
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update content type fields (deprecated v1)
      effect: write
      questions:
      - Can I update several fields of a content type at once with the legacy v1 API?
      - Is there a deprecated v1 call that saves multiple field changes in one request?
      instructions:
      - text: Through the deprecated v1 API, update multiple fields on content type {typeId} in one request.
        slots:
          typeId: path.typeId
      - text: Bulk-save field changes for content type {typeId} using the old v1 fields endpoint.
        slots:
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to a content type (deprecated v1)
      effect: write
      questions:
      - How do I add a new field to a content type with the deprecated v1 fields API?
      - What does the old v1 endpoint need to create a field, like its class and name?
      instructions:
      - text: With the v1 API, add a field named {name} of class {clazz} to content type {typeId}.
        slots:
          name: requestBody.name
          clazz: requestBody.clazz
          typeId: path.typeId
      - text: Create a required v1 field {name} ({clazz}) on content type {typeId} with hint {hint}.
        slots:
          name: requestBody.name
          clazz: requestBody.clazz
          typeId: path.typeId
          hint: requestBody.hint
      - text: Add a unique, indexed v1 field {name} of type {clazz} with variable {variable} to content type {typeId}.
        slots:
          name: requestBody.name
          clazz: requestBody.clazz
          variable: requestBody.variable
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several fields (deprecated v1)
      effect: destructive
      questions:
      - Can I remove multiple fields from a content type in one call with the old v1 API?
      - How do I bulk delete fields by their IDs using the deprecated v1 endpoint?
      instructions:
      - text: Using the deprecated v1 endpoint, delete a batch of fields from content type {typeId}.
        slots:
          typeId: path.typeId
      - text: Bulk-remove the listed field IDs from content type {typeId} via the legacy v1 API.
        slots:
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field by ID (deprecated v1)
      effect: read
      questions:
      - How do I look up one content type field by its field ID with the v1 API?
      - Does the deprecated v1 endpoint return a single field's settings by ID?
      instructions:
      - text: Via the deprecated v1 API, get field {fieldId} from content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      - text: Show the v1 definition of field ID {fieldId} on content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field by ID (deprecated v1)
      effect: write
      questions:
      - How do I change one field identified by its ID using the legacy v1 API?
      - Can the old v1 endpoint update a single field's settings by field ID?
      instructions:
      - text: Using the deprecated v1 API, update field {fieldId} on content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      - text: Save changes to v1 field ID {fieldId} in content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field by ID (deprecated v1)
      effect: destructive
      questions:
      - How do I delete a single field by its ID with the deprecated v1 fields API?
      - Can I remove one field from a content type through the old v1 by-ID endpoint?
      instructions:
      - text: Through the v1 API, delete field {fieldId} from content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      - text: Remove v1 field ID {fieldId} from content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field by variable name (deprecated v1)
      effect: read
      questions:
      - How do I find a field by its variable name using the old v1 API?
      - Can the deprecated v1 endpoint look up a field by velocity variable instead of ID?
      instructions:
      - text: With the deprecated v1 API, get the field with variable {fieldVar} on content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      - text: Show v1 field {fieldVar} (by variable name) from content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field by variable name (deprecated v1)
      effect: write
      questions:
      - Can I update a field addressed by its variable name through the v1 API?
      - How do I edit a content type field by velocity variable using the deprecated endpoint?
      instructions:
      - text: Using the v1 API, update the field with variable {fieldVar} on content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      - text: Save changes to v1 field variable {fieldVar} in content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field by variable name (deprecated v1)
      effect: destructive
      questions:
      - How do I delete a field by its variable name with the old v1 API?
      - Can the deprecated v1 endpoint remove a field when I only know its velocity variable?
      instructions:
      - text: Via the deprecated v1 API, delete the field with variable {fieldVar} from content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      - text: Remove v1 field {fieldVar} by variable name from content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List a field's variables by field ID
      effect: read
      questions:
      - How do I see all field variables attached to a field when I have its ID?
      - What field variables are configured on a given content type field?
      instructions:
      - text: List the field variables on field ID {fieldId} of content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      - text: Show every key/value field variable for field {fieldId} in content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field variable by field ID
      effect: write
      questions:
      - How do I add a field variable to a field identified by its ID?
      - Can I attach a new key/value setting to a content type field using the field ID?
      instructions:
      - text: Create a new field variable on field ID {fieldId} of content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      - text: Add a field variable to field {fieldId} (by ID) in content type {typeId}.
        slots:
          fieldId: path.fieldId
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List a field's variables by field variable name
      effect: read
      questions:
      - How do I list field variables when I only know the field's velocity variable name?
      - Which field variables exist on a field I reference by variable name?
      instructions:
      - text: List the field variables on field {fieldVar} (by variable name) of content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      - text: Show all field variables for the field named by variable {fieldVar} in content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field variable by field variable name
      effect: write
      questions:
      - Can I create a field variable on a field addressed by its velocity variable name?
      - How do I add a key/value field variable without knowing the field's ID?
      instructions:
      - text: Create a field variable on field {fieldVar} (by variable name) of content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      - text: Add a new field variable to the field with velocity variable {fieldVar} in content type {typeId}.
        slots:
          fieldVar: path.fieldVar
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one field variable via field ID
      effect: read
      questions:
      - How do I read a single field variable when I know the field ID and the variable ID?
      - Can I fetch just one field variable rather than the whole list for a field ID?
      instructions:
      - text: Get field variable {fieldVarId} on field ID {fieldId} of content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldId: path.fieldId
          typeId: path.typeId
      - text: Show the value of field variable {fieldVarId} for field {fieldId} in content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldId: path.fieldId
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field variable via field ID
      effect: write
      questions:
      - How do I change an existing field variable on a field I reference by ID?
      - Can I edit a field variable's value using the field ID and variable ID?
      instructions:
      - text: Update field variable {fieldVarId} on field ID {fieldId} of content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldId: path.fieldId
          typeId: path.typeId
      - text: Change the stored value of field variable {fieldVarId} for field {fieldId} in content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldId: path.fieldId
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field variable via field ID
      effect: destructive
      questions:
      - How do I remove a field variable from a field identified by its ID?
      - Can I delete one field variable using the field ID and variable ID?
      instructions:
      - text: Delete field variable {fieldVarId} from field ID {fieldId} of content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldId: path.fieldId
          typeId: path.typeId
      - text: Remove variable {fieldVarId} from field {fieldId} in content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldId: path.fieldId
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one field variable via field variable name
      effect: read
      questions:
      - How do I read one field variable when I reference the field by its velocity variable?
      - Can I fetch a single field variable by ID on a field named by variable?
      instructions:
      - text: Get field variable {fieldVarId} on field {fieldVar} (by variable name) of content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldVar: path.fieldVar
          typeId: path.typeId
      - text: Show variable {fieldVarId} of the field with velocity variable {fieldVar} in content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldVar: path.fieldVar
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field variable via field variable name
      effect: write
      questions:
      - How do I edit a field variable on a field I reference by velocity variable name?
      - Can I update a field variable without knowing the parent field's ID?
      instructions:
      - text: Update field variable {fieldVarId} on field {fieldVar} (by variable name) of content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldVar: path.fieldVar
          typeId: path.typeId
      - text: Change variable {fieldVarId} on the field with velocity variable {fieldVar} in content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldVar: path.fieldVar
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field variable via field variable name
      effect: destructive
      questions:
      - How do I delete a field variable from a field referenced by its velocity variable?
      - Can I remove a field variable when I only know the field's variable name?
      instructions:
      - text: Delete field variable {fieldVarId} from field {fieldVar} (by variable name) of content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldVar: path.fieldVar
          typeId: path.typeId
      - text: Remove variable {fieldVarId} from the field with velocity variable {fieldVar} in content type {typeId}.
        slots:
          fieldVarId: path.fieldVarId
          fieldVar: path.fieldVar
          typeId: path.typeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List a content type's fields (v2)
      effect: read
      questions:
      - How do I list a content type's fields with the v2 API using its ID or variable name?
      - Can the v2 fields endpoint return fields when I only know the content type's variable name?
      instructions:
      - text: Using the v2 fields API, list all fields of content type {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      - text: Get the v2 field list for content type ID or variable {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update content type fields (v2)
      effect: write
      questions:
      - How do I update several fields of a content type in one v2 request?
      - Can the v2 API save multiple field edits addressed by content type variable name?
      instructions:
      - text: With the v2 API, update multiple fields on content type {typeIdOrVarName} at once.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      - text: Bulk-save v2 field changes for content type {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to a content type (v2)
      effect: write
      questions:
      - How do I add a new field to a content type with the v2 fields API?
      - Can I create a field on a content type referenced by its variable name in v2?
      instructions:
      - text: Using the v2 API, create a new field on content type {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      - text: Add a v2 field definition to content type {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several fields (v2)
      effect: destructive
      questions:
      - How do I remove multiple fields from a content type with the v2 API?
      - Can v2 bulk delete fields from a content type I name by variable?
      instructions:
      - text: With the v2 API, delete a batch of fields from content type {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      - text: Bulk-remove fields from content type {typeIdOrVarName} through the v2 fields endpoint.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field by ID (v2)
      effect: read
      questions:
      - How do I fetch one content type field by its ID through the v2 API?
      - Does the v2 fields API return a single field's full definition?
      instructions:
      - text: Using the v2 API, get content type field {fieldId}.
        slots:
          fieldId: path.fieldId
      - text: Show the v2 definition of field ID {fieldId}.
        slots:
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field by ID (v2)
      effect: write
      questions:
      - How do I update a single content type field by ID with the v2 API?
      - Can I change one field's settings through the v2 by-ID endpoint?
      instructions:
      - text: With the v2 API, update content type field {fieldId}.
        slots:
          fieldId: path.fieldId
      - text: Save new settings for v2 field ID {fieldId}.
        slots:
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field by ID (v2)
      effect: destructive
      questions:
      - How do I delete one content type field by its ID in the v2 API?
      - Can the v2 by-ID endpoint remove a single field?
      instructions:
      - text: Using the v2 API, delete content type field {fieldId}.
        slots:
          fieldId: path.fieldId
      - text: Remove v2 field ID {fieldId} from its content type.
        slots:
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field by variable name (v2)
      effect: read
      questions:
      - How do I look up a field by its variable name with the v2 API?
      - Can v2 return a field when I know both the content type and field variable names?
      instructions:
      - text: With the v2 API, get field {fieldVar} from content type {typeIdOrVarName}.
        slots:
          fieldVar: path.fieldVar
          typeIdOrVarName: path.typeIdOrVarName
      - text: Show v2 field variable {fieldVar} on content type {typeIdOrVarName}.
        slots:
          fieldVar: path.fieldVar
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field by variable name (v2)
      effect: write
      questions:
      - How do I update a field addressed by variable name through the v2 API?
      - Can v2 edit a field when I reference it by its velocity variable?
      instructions:
      - text: Using the v2 API, update field {fieldVar} on content type {typeIdOrVarName}.
        slots:
          fieldVar: path.fieldVar
          typeIdOrVarName: path.typeIdOrVarName
      - text: Save changes to v2 field variable {fieldVar} in content type {typeIdOrVarName}.
        slots:
          fieldVar: path.fieldVar
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field by variable name (v2)
      effect: destructive
      questions:
      - How do I delete a field by its variable name with the v2 API?
      - Can the v2 endpoint remove a field I name by velocity variable?
      instructions:
      - text: With the v2 API, delete field {fieldVar} from content type {typeIdOrVarName}.
        slots:
          fieldVar: path.fieldVar
          typeIdOrVarName: path.typeIdOrVarName
      - text: Remove v2 field variable {fieldVar} from content type {typeIdOrVarName}.
        slots:
          fieldVar: path.fieldVar
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/contenttype/{typeIdOrVarName}/fields/allfields'].get
  update:
    x-apievangelist-phrasing:
      intent: Filter a content type's fields by criteria
      effect: read
      questions:
      - Can I get only the fields of a content type that match a filter?
      - Which fields in a content type meet the criteria I specify?
      instructions:
      - text: List the fields in content type {typeIdOrVarName} that match filter {filter}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
          filter: query.filter
      - text: Return the filtered set of fields for content type {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/contenttype/{typeIdOrVarName}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a content type's field layout
      effect: read
      questions:
      - How are a content type's fields arranged into rows and columns?
      - Can I see the edit-form layout of a content type without changing anything?
      instructions:
      - text: Show the row and column field layout of content type {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      - text: Get the current field layout for content type {typeIdOrVarName}, repaired if invalid.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/contenttype/{typeIdOrVarName}/fields'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete fields and return the updated layout
      effect: destructive
      questions:
      - How do I delete fields from a content type and get back the new layout?
      - Why can't I delete the field used as a content type's publish or expire date?
      instructions:
      - text: Delete fields {fieldsID} from content type {typeIdOrVarName} and return the updated layout.
        slots:
          fieldsID: requestBody.fieldsID
          typeIdOrVarName: path.typeIdOrVarName
      - text: Remove those field IDs from content type {typeIdOrVarName} and tell me which were actually deleted.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/contenttype/{typeIdOrVarName}/fields/move'].put
  update:
    x-apievangelist-phrasing:
      intent: Move or add a field in the layout
      effect: write
      questions:
      - How do I move a field to a different row or column in a content type's layout?
      - Can I drag and drop a new field into a content type programmatically?
      instructions:
      - text: Move a field to a new position in the layout of content type {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      - text: Drop a new field into the layout of content type {typeIdOrVarName}.
        slots:
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/contenttype/{typeIdOrVarName}/fields/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field wrapped in a field object
      effect: write
      questions:
      - How do I change a widget field's widgetCode on a content type?
      - What request shape does the v3 field update expect, with the top-level field property?
      instructions:
      - text: Update field {id} on content type {typeIdOrVarName} with field definition {field}.
        slots:
          id: path.id
          typeIdOrVarName: path.typeIdOrVarName
          field: requestBody.field
      - text: Change the values of widget field {id} in content type {typeIdOrVarName}, preserving its other attributes.
        slots:
          id: path.id
          typeIdOrVarName: path.typeIdOrVarName
      method: generated
      generated: '2026-09-26'