SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Reverse DNS API

6 actions 6 updates phrasing extends openapi/sendgrid-reverse-dns-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for SendGrid's API. It is a proposal applied on top of the contract, not a document SendGrid publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v3/whitelabel/ips'].get

$.paths['/v3/whitelabel/ips'].post

$.paths['/v3/whitelabel/ips/{id}'].get

$.paths['/v3/whitelabel/ips/{id}'].delete

$.paths['/v3/whitelabel/ips/{id}/validate'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Reverse DNS API
  version: 1.0.0
extends: openapi/sendgrid-reverse-dns-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v3/whitelabel/ips'].get
  update:
    x-apievangelist-phrasing:
      intent: List reverse DNS records
      effect: read
      questions:
      - Which of my IPs have reverse DNS set up?
      - Can I search reverse DNS records by an IP prefix?
      instructions:
      - text: List all my reverse DNS records.
      - text: Find reverse DNS records for IPs starting with {ip}.
        slots:
          ip: query.ip
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/ips'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up reverse DNS for an IP
      effect: write
      questions:
      - Can I make a dedicated IP resolve back to my own domain?
      - What domain and subdomain does reverse DNS need?
      instructions:
      - text: Set up reverse DNS for IP {ip} on {domain}.
        slots:
          ip: requestBody.ip
          domain: requestBody.domain
      - text: Point IP {ip} to subdomain {subdomain} of {domain}.
        slots:
          ip: requestBody.ip
          subdomain: requestBody.subdomain
          domain: requestBody.domain
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/ips/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reverse DNS record
      effect: read
      questions:
      - What A record do I need for a particular reverse DNS setup?
      - Is a given reverse DNS record valid yet?
      instructions:
      - text: Show reverse DNS record {id}.
        slots:
          id: path.id
      - text: Get the A record details for reverse DNS {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/ips/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a reverse DNS record
      effect: destructive
      questions:
      - Can I remove reverse DNS from one of my IPs?
      - Is deleting a reverse DNS record reversible?
      instructions:
      - text: Delete reverse DNS record {id}.
        slots:
          id: path.id
      - text: Remove reverse DNS setup {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/ips/{id}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a reverse DNS record
      effect: write
      questions:
      - I've added the A record — does my reverse DNS validate now?
      - Which field tells me whether reverse DNS validation passed?
      instructions:
      - text: Validate reverse DNS record {id}.
        slots:
          id: path.id
      - text: Check whether reverse DNS {id} resolves correctly.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'