Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Template Category API

6 actions 6 updates phrasing extends openapi/conga-email-template-category-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/api/email/v1/email-template-categories'].get
$.paths['/api/email/v1/email-template-categories'].post
$.paths['/api/email/v1/email-template-categories/{id}'].get
$.paths['/api/email/v1/email-template-categories/{id}'].put
$.paths['/api/email/v1/email-template-categories/{id}'].delete

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 Email Template Category API
  version: 1.0.0
extends: openapi/conga-email-template-category-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: 5
- target: $.paths['/api/email/v1/email-template-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List email template categories
      effect: read
      questions:
      - What categories are my email templates organized into?
      - Can I list the child categories under one parent?
      instructions:
      - text: List email template categories.
      - text: Show categories under parent {parent}.
        slots:
          parent: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-template-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email template category
      effect: write
      questions:
      - How do I add a new folder-like category for templates?
      - What access type must a new template category have?
      instructions:
      - text: Create a {type} template category named {name} with access {access}.
        slots:
          type: requestBody.CategoryType
          name: requestBody.Name
          access: requestBody.AccessType
      - text: Add category {name} under parent {parent} with type {type} and access {access}.
        slots:
          name: requestBody.Name
          parent: requestBody.ParentId
          type: requestBody.CategoryType
          access: requestBody.AccessType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-template-categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email template category
      effect: read
      questions:
      - Can I look up a single template category's details?
      - Which parent does a given category belong to?
      instructions:
      - text: Get template category {id}.
        slots:
          id: path.id
      - text: Show the details of category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-template-categories/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an email template category
      effect: write
      questions:
      - How do I rename an existing template category?
      - Can I move a category under a different parent?
      instructions:
      - text: Rename category {id} to {name}, keeping type {type} and access {access}.
        slots:
          id: path.id
          name: requestBody.Name
          type: requestBody.CategoryType
          access: requestBody.AccessType
      - text: Move category {id} under parent {parent}.
        slots:
          id: path.id
          parent: requestBody.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-template-categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email template category
      effect: destructive
      questions:
      - Can I delete a template category I no longer need?
      - What happens when I remove a template category?
      instructions:
      - text: Delete template category {id}.
        slots:
          id: path.id
      - text: Remove category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'