# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Trello Checklists API
  version: 1.0.0
extends: openapi/trello-checklists-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: 12
- target: $.paths['/checklists'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a checklist to a card
      effect: write
      questions:
      - How do I add a checklist to a Trello card?
      - Can I copy an existing checklist onto another card?
      instructions:
      - text: Add a checklist named {name} to card {idCard}.
        slots:
          name: query.name
          idCard: query.idCard
      - text: Copy checklist {idChecklistSource} onto card {idCard}.
        slots:
          idChecklistSource: query.idChecklistSource
          idCard: query.idCard
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a checklist with its items
      effect: read
      questions:
      - How do I fetch a whole checklist including its check items?
      - Can I get a checklist along with the card it sits on?
      instructions:
      - text: Get checklist {id}.
        slots:
          id: path.id
      - text: Fetch checklist {id} with check items set to {checkItems}.
        slots:
          id: path.id
          checkItems: query.checkItems
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or reorder a checklist
      effect: write
      questions:
      - Can I rename a checklist on a card?
      - How do I move a checklist to the top of a card?
      instructions:
      - text: Rename checklist {id} to {name}.
        slots:
          id: path.id
          name: query.name
      - text: Move checklist {id} to position {pos}.
        slots:
          id: path.id
          pos: query.pos
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a checklist
      effect: destructive
      questions:
      - How do I delete an entire checklist from a card?
      - Is removing a checklist permanent?
      instructions:
      - text: Delete checklist {id}.
        slots:
          id: path.id
      - text: Permanently remove checklist {id} and its items.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}/checkItems'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items on a checklist
      effect: read
      questions:
      - What items are on a checklist, and which are done?
      - Can I list only the incomplete items on a checklist?
      instructions:
      - text: List the check items on checklist {id}.
        slots:
          id: path.id
      - text: Show checklist {id}'s items filtered by {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}/checkItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an item to a checklist
      effect: write
      questions:
      - How do I add a to-do item to an existing checklist?
      - Can I assign a new checklist item to someone and give it a due date?
      instructions:
      - text: Add item {name} to checklist {id}.
        slots:
          name: query.name
          id: path.id
      - text: Add {name} to checklist {id}, due {due} and assigned to {idMember}.
        slots:
          name: query.name
          id: path.id
          due: query.due
          idMember: query.idMember
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}/checkItems/{idCheckItem}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single checklist item
      effect: read
      questions:
      - How do I check whether one specific checklist item is complete?
      - Can I fetch a single check item by its id?
      instructions:
      - text: Get check item {idCheckItem} on checklist {id}.
        slots:
          idCheckItem: path.idCheckItem
          id: path.id
      - text: Show the state of item {idCheckItem} in checklist {id}.
        slots:
          idCheckItem: path.idCheckItem
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}/checkItems/{idCheckItem}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an item from a checklist
      effect: destructive
      questions:
      - How do I delete a single item from a checklist without deleting the checklist?
      - Can I remove a check item that was added by mistake?
      instructions:
      - text: Delete check item {idCheckItem} from checklist {id}.
        slots:
          idCheckItem: path.idCheckItem
          id: path.id
      - text: Remove item {idCheckItem} on checklist {id}.
        slots:
          idCheckItem: path.idCheckItem
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}/{field}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one field of a checklist
      effect: read
      questions:
      - Can I read just the name or position of a checklist?
      - What's the lightest way to fetch a single checklist field?
      instructions:
      - text: Get the {field} field of checklist {id}.
        slots:
          field: path.field
          id: path.id
      - text: Read only {field} from checklist {id}.
        slots:
          field: path.field
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}/{field}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set one field of a checklist
      effect: write
      questions:
      - Can I update a single checklist field by naming it in the URL?
      - Is there a per-field way to change a checklist's name or pos?
      instructions:
      - text: Set field {field} of checklist {id} to {value}.
        slots:
          field: path.field
          id: path.id
          value: query.value
      - text: Update only the {field} of checklist {id} to {value}.
        slots:
          field: path.field
          id: path.id
          value: query.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}/board'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the board a checklist belongs to
      effect: read
      questions:
      - Which board is this checklist on?
      - Can I find the board from just a checklist id?
      instructions:
      - text: Get the board that checklist {id} is on.
        slots:
          id: path.id
      - text: Show fields {fields} of the board holding checklist {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checklists/{id}/cards'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the card a checklist is on
      effect: read
      questions:
      - Which card does a checklist belong to?
      - How do I get from a checklist id back to its card?
      instructions:
      - text: Get the card that checklist {id} is on.
        slots:
          id: path.id
      - text: Find the parent card of checklist {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'