Encharge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Encharge Settings API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/settings/email/domains'].get
$.paths['/settings/email/domains'].post
$.paths['/settings/email/domains/{id}'].get
$.paths['/settings/email/domains/{id}'].delete
$.paths['/settings/email/domains/{id}/verify'].post

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 Encharge Settings API
  version: 1.0.0
extends: openapi/encharge-settings-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['/settings/email/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List email sending domains
      effect: read
      questions:
      - Which email domains have I added for sending?
      - How do I see the verification status of all my sending domains?
      instructions:
      - text: List my email domains.
      - text: Show all sending domains on the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/email/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email domain for verification
      effect: write
      questions:
      - How do I add my own domain to send email from?
      - What do I need to do after adding a sending domain?
      instructions:
      - text: Add {domain} as an email sending domain.
        slots:
          domain: requestBody.domain
      - text: Start verifying the domain {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/email/domains/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email domain
      effect: read
      questions:
      - How do I check the details of one sending domain?
      - Is a specific email domain verified yet?
      instructions:
      - text: Get email domain {id}.
        slots:
          id: path.id
      - text: Show the verification details for domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/email/domains/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an email domain
      effect: destructive
      questions:
      - How do I remove a sending domain from my account?
      - Can I delete a domain's verification?
      instructions:
      - text: Remove email domain {id}.
        slots:
          id: path.id
      - text: Delete sending domain {id} and its verification.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/email/domains/{id}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-check an email domain's DNS
      effect: write
      questions:
      - I've added the DNS records, how do I trigger the domain check?
      - Can I re-run DNS verification for a sending domain?
      instructions:
      - text: Re-check the DNS records for domain {id}.
        slots:
          id: path.id
      - text: Trigger verification of email domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'