# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Meltwater Explore+ Assets API
  version: 1.0.0
extends: openapi/meltwater-explore-assets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 20
- target: $.paths['/v3/explore_plus/assets/custom_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom fields
      effect: read
      questions:
      - What custom fields are set up in my workspace?
      - Can I page through all custom fields, 100 at a time?
      instructions:
      - text: List all custom fields in workspace {workspace_id}.
        slots:
          workspace_id: query.workspace_id
      - text: Show page {page} of custom fields in workspace {workspace_id}, {page_size} per page.
        slots:
          page: query.page
          workspace_id: query.workspace_id
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field
      effect: write
      questions:
      - How do I add a new custom field for classifying content?
      - Can I create a custom field in the company space rather than a workspace?
      instructions:
      - text: Create custom field {custom_field} in workspace {workspace_id}.
        slots:
          custom_field: requestBody.custom_field
          workspace_id: query.workspace_id
      - text: Add a new custom field {custom_field} to the company space with workspace {workspace_id}.
        slots:
          custom_field: requestBody.custom_field
          workspace_id: query.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom field
      effect: read
      questions:
      - What is configured on a specific custom field?
      - Where can I look up the details of a single custom field by its ID?
      instructions:
      - text: Get custom field {custom_field_id} in workspace {workspace_id}.
        slots:
          custom_field_id: path.custom_field_id
          workspace_id: query.workspace_id
      - text: Show the definition of custom field {custom_field_id}.
        slots:
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field
      effect: write
      questions:
      - How do I rename or change an existing custom field?
      - Can I edit a custom field after it has been created?
      instructions:
      - text: Update custom field {custom_field_id} to {custom_field} in workspace {workspace_id}.
        slots:
          custom_field_id: path.custom_field_id
          custom_field: requestBody.custom_field
          workspace_id: query.workspace_id
      - text: Change the settings of custom field {custom_field_id}.
        slots:
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field
      effect: destructive
      questions:
      - How do I remove a custom field I no longer need?
      - Can I delete a whole custom field rather than just one of its values?
      instructions:
      - text: Delete custom field {custom_field_id} from workspace {workspace_id}.
        slots:
          custom_field_id: path.custom_field_id
          workspace_id: query.workspace_id
      - text: Remove custom field {custom_field_id} entirely.
        slots:
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}/values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a value to a custom field
      effect: write
      questions:
      - How do I add a new option to an existing custom field?
      - Can I create additional values under a custom field?
      instructions:
      - text: Add value {custom_field_value} to custom field {custom_field_id} in workspace {workspace_id}.
        slots:
          custom_field_value: requestBody.custom_field_value
          custom_field_id: path.custom_field_id
          workspace_id: query.workspace_id
      - text: Create a new option {custom_field_value} under custom field {custom_field_id}.
        slots:
          custom_field_value: requestBody.custom_field_value
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom field value
      effect: read
      questions:
      - What does a particular value of a custom field contain?
      - Where do I look up a single custom field value by its ID?
      instructions:
      - text: Get value {value_id} of custom field {custom_field_id} in workspace {workspace_id}.
        slots:
          value_id: path.value_id
          custom_field_id: path.custom_field_id
          workspace_id: query.workspace_id
      - text: Show the details of custom field value {value_id} on field {custom_field_id}.
        slots:
          value_id: path.value_id
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field value
      effect: write
      questions:
      - How do I rename one of the values in a custom field?
      - Can I edit a single custom field value without touching the field itself?
      instructions:
      - text: Update value {value_id} of custom field {custom_field_id} to {custom_field_value} in workspace {workspace_id}.
        slots:
          value_id: path.value_id
          custom_field_id: path.custom_field_id
          custom_field_value: requestBody.custom_field_value
          workspace_id: query.workspace_id
      - text: Rename option {value_id} on custom field {custom_field_id}.
        slots:
          value_id: path.value_id
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field value
      effect: destructive
      questions:
      - How do I remove one option from a custom field but keep the field?
      - Can I delete a custom field value that is no longer used?
      instructions:
      - text: Delete value {value_id} from custom field {custom_field_id} in workspace {workspace_id}.
        slots:
          value_id: path.value_id
          custom_field_id: path.custom_field_id
          workspace_id: query.workspace_id
      - text: Remove option {value_id} on custom field {custom_field_id}.
        slots:
          value_id: path.value_id
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an assignment rule for a field value
      effect: write
      questions:
      - How do I automatically assign a custom field value to matching content?
      - Can I add a rule that applies a custom field value for me?
      instructions:
      - text: Create assignment rule {rule} for value {value_id} of custom field {custom_field_id} in workspace {workspace_id}.
        slots:
          rule: requestBody.rule
          value_id: path.value_id
          custom_field_id: path.custom_field_id
          workspace_id: query.workspace_id
      - text: Add an auto-assign rule {rule} to option {value_id} on field {custom_field_id}.
        slots:
          rule: requestBody.rule
          value_id: path.value_id
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}/rules/{rule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one assignment rule
      effect: read
      questions:
      - What conditions does a particular assignment rule use?
      - Where can I inspect a single rule that assigns a custom field value?
      instructions:
      - text: Get assignment rule {rule_id} on value {value_id} of custom field {custom_field_id} in workspace {workspace_id}.
        slots:
          rule_id: path.rule_id
          value_id: path.value_id
          custom_field_id: path.custom_field_id
          workspace_id: query.workspace_id
      - text: Show the conditions of assignment rule {rule_id} for field {custom_field_id}, value {value_id}.
        slots:
          rule_id: path.rule_id
          custom_field_id: path.custom_field_id
          value_id: path.value_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}/rules/{rule_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an assignment rule
      effect: write
      questions:
      - How do I change the conditions on an existing assignment rule?
      - Can I edit an auto-assign rule instead of deleting and recreating it?
      instructions:
      - text: Update assignment rule {rule_id} on value {value_id} of field {custom_field_id} to {rule}, workspace {workspace_id}.
        slots:
          rule_id: path.rule_id
          value_id: path.value_id
          custom_field_id: path.custom_field_id
          rule: requestBody.rule
          workspace_id: query.workspace_id
      - text: Change the conditions of assignment rule {rule_id} for field {custom_field_id}, value {value_id}.
        slots:
          rule_id: path.rule_id
          custom_field_id: path.custom_field_id
          value_id: path.value_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}/rules/{rule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an assignment rule
      effect: destructive
      questions:
      - How do I stop a custom field value from being auto-assigned?
      - Can I remove one assignment rule while keeping the value?
      instructions:
      - text: Delete assignment rule {rule_id} on value {value_id} of field {custom_field_id} in workspace {workspace_id}.
        slots:
          rule_id: path.rule_id
          value_id: path.value_id
          custom_field_id: path.custom_field_id
          workspace_id: query.workspace_id
      - text: Remove auto-assign rule {rule_id} from field {custom_field_id}, value {value_id}.
        slots:
          rule_id: path.rule_id
          custom_field_id: path.custom_field_id
          value_id: path.value_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/custom_fields/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field folders
      effect: read
      questions:
      - How are my custom fields organised into folders?
      - Which folders hold custom fields in a workspace?
      instructions:
      - text: List the custom field folders in workspace {workspace_id}.
        slots:
          workspace_id: query.workspace_id
      - text: Show page {page} of custom field folders for workspace {workspace_id}.
        slots:
          page: query.page
          workspace_id: query.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/searches'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved searches
      effect: read
      questions:
      - What saved searches exist in my workspace?
      - Can I list only the searches inside one folder, including hidden ones?
      instructions:
      - text: List all saved searches in workspace {workspace_id}.
        slots:
          workspace_id: query.workspace_id
      - text: 'Show the searches in folder {folder_id} of workspace {workspace_id}, including hidden: {show_hidden}.'
        slots:
          folder_id: query.folder_id
          workspace_id: query.workspace_id
          show_hidden: query.show_hidden
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/searches'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a saved search
      effect: write
      questions:
      - How do I set up a new saved search for my private index?
      - Can I create a search in the company space instead of a workspace?
      instructions:
      - text: Create saved search {search} in workspace {workspace_id}.
        slots:
          search: requestBody.search
          workspace_id: query.workspace_id
      - text: Set up a new search {search} for company {company_id}, workspace {workspace_id}.
        slots:
          search: requestBody.search
          company_id: query.company_id
          workspace_id: query.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/searches/{search_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one saved search
      effect: read
      questions:
      - What query and settings does a particular saved search use?
      - Where can I look up a single search definition by its ID?
      instructions:
      - text: Get saved search {search_id} in workspace {workspace_id}.
        slots:
          search_id: path.search_id
          workspace_id: query.workspace_id
      - text: Show the query behind search {search_id}.
        slots:
          search_id: path.search_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/searches/{search_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a saved search
      effect: write
      questions:
      - How do I change the query of an existing saved search?
      - Can I edit a search definition after creating it?
      instructions:
      - text: Update saved search {search_id} to {search} in workspace {workspace_id}.
        slots:
          search_id: path.search_id
          search: requestBody.search
          workspace_id: query.workspace_id
      - text: Edit the query of search {search_id}.
        slots:
          search_id: path.search_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/searches/{search_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved search
      effect: destructive
      questions:
      - How do I remove a saved search I no longer use?
      - Can I permanently delete a search from my workspace?
      instructions:
      - text: Delete saved search {search_id} from workspace {workspace_id}.
        slots:
          search_id: path.search_id
          workspace_id: query.workspace_id
      - text: Remove search {search_id} permanently.
        slots:
          search_id: path.search_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/explore_plus/assets/searches/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved search folders
      effect: read
      questions:
      - Which folders are my saved searches organised into?
      - Can I include hidden folders when listing search folders?
      instructions:
      - text: List the search folders in workspace {workspace_id}.
        slots:
          workspace_id: query.workspace_id
      - text: 'Show all search folders for workspace {workspace_id}, hidden ones included: {show_hidden}.'
        slots:
          workspace_id: query.workspace_id
          show_hidden: query.show_hidden
      method: generated
      generated: '2026-10-01'