# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Resource Collections API
  version: 1.0.0
extends: openapi/zendesk-resource-collections-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: 5
- target: $.paths['/api/v2/resource_collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource collections
      effect: read
      questions:
      - What resource collections exist on our account?
      - Where can I see the bundles of fields and triggers created from app requirements?
      instructions:
      - text: List all resource collections in the account.
      - text: Show every resource collection we've created.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/resource_collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a resource collection from a payload
      effect: write
      questions:
      - How do I create ticket fields, triggers and targets together from a requirements.json-style payload?
      - Can I provision app requirements as a resource collection without installing an app?
      instructions:
      - text: Create a resource collection from this requirements payload.
      - text: Provision the ticket fields and triggers in this payload as one resource collection.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/resource_collections/{resource_collection_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource collection
      effect: read
      questions:
      - How do I see what resources are in one resource collection?
      - What details does a single resource collection return?
      instructions:
      - text: Show that resource collection's details.
      - text: Get the resources belonging to this collection.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/resource_collections/{resource_collection_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a resource collection
      effect: write
      questions:
      - Can I change the resources in a collection by sending a new payload?
      - How do I update an existing resource collection's requirements?
      instructions:
      - text: Update that resource collection with this revised payload.
      - text: Add a new trigger to the existing resource collection.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/resource_collections/{resource_collection_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resource collection
      effect: destructive
      questions:
      - What happens to the resources when I delete a resource collection?
      - Can I track the job that removes a collection's resources?
      instructions:
      - text: Delete that resource collection and its resources.
      - text: Remove this resource collection and give me the job status.
      method: generated
      generated: '2026-09-26'