API Evangelist conversational phrasing for Approvals Business Objects API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Approvals Business Objects API
  version: 1.0.0
extends: openapi/conga-businessobjects-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: 15
- target: $.paths['/v1/business-objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List business object types
      effect: read
      questions:
      - Which business object types can approvals run on in Conga?
      - Are agreements, proposals and line items all available as object types?
      instructions:
      - text: List the business object types available for approvals.
      - text: Show me every supported business object type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/assignee-picklists'].get
  update:
    x-apievangelist-phrasing:
      intent: List assignee type values for all objects
      effect: read
      questions:
      - What related-user assignee values exist across all business objects?
      - Can I get the assignee picklists for every object type at once?
      instructions:
      - text: List assignee type picklist values for all business objects.
      - text: Get every object's related-user assignee options in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/assignee-picklists'].get
  update:
    x-apievangelist-phrasing:
      intent: List one object's assignee type values
      effect: read
      questions:
      - Which related-user assignee values can I use for a specific object type?
      - What can I put as the assignee ID for a Related User step on this object?
      instructions:
      - text: List assignee picklist values for the {name} object.
        slots:
          name: path.name
      - text: Show related-user assignee options for {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/category/{emailTemplateCategory}/email-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List email templates for an object and category
      effect: read
      questions:
      - Which email templates exist for one object type within a specific category?
      - Can I narrow an object's email templates to one category and a name filter?
      instructions:
      - text: List {emailTemplateCategory} email templates for the {name} object.
        slots:
          emailTemplateCategory: path.emailTemplateCategory
          name: path.name
      - text: Find {name} templates in category {emailTemplateCategory} matching {filter}.
        slots:
          name: path.name
          emailTemplateCategory: path.emailTemplateCategory
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/child-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List a business object's child types
      effect: read
      questions:
      - What child object types sit under a given business object?
      - Does an agreement have child objects I can approve at the line level?
      instructions:
      - text: List child object types of {name}.
        slots:
          name: path.name
      - text: Show which child types the {name} object has.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/custom-user-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List an object's custom user fields
      effect: read
      questions:
      - Which user fields on an object can drive a Custom User assignee?
      - What custom user fields are available when routing a step to a custom user?
      instructions:
      - text: List custom user fields on the {name} object.
        slots:
          name: path.name
      - text: Show fields I can use for a Custom User assignee on {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/custom-user-fields/{id}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a custom assignee definition
      effect: read
      questions:
      - Can I check a custom assignee expression is valid before saving the step?
      - Will this custom user assignee configuration resolve on my object?
      instructions:
      - text: Validate custom assignee {id} on the {name} object.
        slots:
          id: path.id
          name: path.name
      - text: Check custom user field {id} on {name} using assignee type {assigneeType}.
        slots:
          id: path.id
          name: path.name
          assigneeType: query.assigneeType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/email-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List email templates for an object type
      effect: read
      questions:
      - Which notification email templates are available for a given object type?
      - Can I search one object's email templates by name regardless of category?
      instructions:
      - text: Show every email template for {name} across all categories.
        slots:
          name: path.name
      - text: Find {name} email templates named like {filter}.
        slots:
          name: path.name
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List a business object's fields
      effect: read
      questions:
      - What fields does a business object have that I can use in criteria?
      - Can I get field details for the agreement object?
      instructions:
      - text: List the fields on the {name} object.
        slots:
          name: path.name
      - text: Show field information for {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/processes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a business object's approval processes
      effect: read
      questions:
      - Which approval processes are attached to this object type?
      - Can I list only the inactive approval processes on one object?
      instructions:
      - text: List approval processes on the {name} object.
        slots:
          name: path.name
      - text: Show {name} processes where active is {active}.
        slots:
          name: path.name
          active: query.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/reorder-processes'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder one object's approval processes
      effect: write
      questions:
      - Can I change the order approval processes run in for one object?
      - What sets the new sequence when I reorder an object's processes?
      instructions:
      - text: Reorder the approval processes on the {name} object.
        slots:
          name: path.name
      - text: Resequence {name} approval processes in the order I list.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a business object's approval rules
      effect: read
      questions:
      - Which approval rules apply to a given business object?
      - Can I page through only the active rules on one object?
      instructions:
      - text: List the approval rules on {name}.
        slots:
          name: path.name
      - text: Show {name} rules where active is {active}.
        slots:
          name: path.name
          active: query.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-objects/{name}/rules/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an object's active and inactive rules
      effect: read
      questions:
      - How many active and inactive rules does an object have?
      - Is there a rule count summary for one business object?
      instructions:
      - text: Count active and inactive rules for {name}.
        slots:
          name: path.name
      - text: Give me rule stats for the {name} object.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/category/{emailTemplateCategory}/email-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List email templates in a category
      effect: read
      questions:
      - Which email templates belong to one category across all objects?
      - Can I list approval email templates by category without picking an object?
      instructions:
      - text: List email templates in category {emailTemplateCategory}.
        slots:
          emailTemplateCategory: path.emailTemplateCategory
      - text: Find {emailTemplateCategory} templates named like {filter}.
        slots:
          emailTemplateCategory: path.emailTemplateCategory
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/email-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List all email templates
      effect: read
      questions:
      - What approval email templates exist in my org overall?
      - Can I search every email template by name?
      instructions:
      - text: List all available email templates.
      - text: Search all email templates for {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'