SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid IP Address IP Pools API

8 actions 8 updates phrasing extends openapi/sendgrid-ip-pools-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 8

$.info
$.paths['/v3/ips/pools'].get
$.paths['/v3/ips/pools'].post
$.paths['/v3/ips/pools/{pool_name}'].get
$.paths['/v3/ips/pools/{pool_name}'].put
$.paths['/v3/ips/pools/{pool_name}'].delete
$.paths['/v3/ips/pools/{pool_name}/ips'].post
$.paths['/v3/ips/pools/{pool_name}/ips/{ip}'].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 Twilio SendGrid IP Address IP Pools API
  version: 1.0.0
extends: openapi/sendgrid-ip-pools-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: 7
- target: $.paths['/v3/ips/pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List all IP pools
      effect: read
      questions:
      - Which IP pools have I set up?
      - What sending IP pools exist on my account?
      instructions:
      - text: List all my IP pools.
      - text: Show every IP pool I have.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/ips/pools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IP pool
      effect: write
      questions:
      - Can I group my dedicated IPs into a pool for a certain type of mail?
      - What do I need to do before I can create an IP pool?
      instructions:
      - text: Create an IP pool named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new IP pool called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/ips/pools/{pool_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the IPs in a pool
      effect: read
      questions:
      - Which IP addresses are in a particular pool?
      - Can I see what's inside one of my IP pools?
      instructions:
      - text: Show the IPs in pool {pool_name}.
        slots:
          pool_name: path.pool_name
      - text: List the addresses in IP pool {pool_name}.
        slots:
          pool_name: path.pool_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/ips/pools/{pool_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an IP pool
      effect: write
      questions:
      - Can I change the name of an existing IP pool?
      - Is renaming an IP pool possible without recreating it?
      instructions:
      - text: Rename IP pool {pool_name} to {name}.
        slots:
          pool_name: path.pool_name
          name: requestBody.name
      - text: Change the name of pool {pool_name} to {name}.
        slots:
          pool_name: path.pool_name
          name: requestBody.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/ips/pools/{pool_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IP pool
      effect: destructive
      questions:
      - Can I delete an IP pool I don't use anymore?
      - What happens to a pool's IPs when I remove the pool?
      instructions:
      - text: Delete IP pool {pool_name}.
        slots:
          pool_name: path.pool_name
      - text: Remove the pool named {pool_name}.
        slots:
          pool_name: path.pool_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/ips/pools/{pool_name}/ips'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an IP address to a pool
      effect: write
      questions:
      - Can the same IP address belong to more than one pool?
      - How long does it take for an IP to show up in a pool after I add it?
      instructions:
      - text: Add IP {ip} to pool {pool_name}.
        slots:
          ip: requestBody.ip
          pool_name: path.pool_name
      - text: Put address {ip} into IP pool {pool_name}.
        slots:
          ip: requestBody.ip
          pool_name: path.pool_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/ips/pools/{pool_name}/ips/{ip}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an IP address from a pool
      effect: destructive
      questions:
      - Can I take one IP out of a pool without deleting the pool?
      - What's the way to pull an address from an IP pool?
      instructions:
      - text: Remove IP {ip} from pool {pool_name}.
        slots:
          ip: path.ip
          pool_name: path.pool_name
      - text: Take address {ip} out of IP pool {pool_name}.
        slots:
          ip: path.ip
          pool_name: path.pool_name
      method: generated
      generated: '2026-09-24'