SMTP2GO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SMTP2GO IP AUTH API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/ip_auth/edit'].patch
$.paths['/ip_auth/remove'].post
$.paths['/ip_auth/view'].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 SMTP2GO IP AUTH API
  version: 1.0.0
extends: openapi/smtp2go-ip-auth-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: 3
- target: $.paths['/ip_auth/edit'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an IP Auth entry
      effect: write
      questions:
      - Can I change settings on an IP-authenticated sender without resending them all?
      - How do I adjust the rate limit for one IP Auth entry?
      instructions:
      - text: Patch IP Auth {ip_address} to set its description to {description}.
        slots:
          ip_address: requestBody.ip_address
          description: requestBody.description
      - text: Change the status of IP Auth entry {ip_address} to {status}.
        slots:
          ip_address: requestBody.ip_address
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ip_auth/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove an IP Auth entry
      effect: destructive
      questions:
      - How do I stop an IP address from authenticating to send mail?
      - Can I delete an IP Auth entry on a subaccount?
      instructions:
      - text: Remove IP Auth entry {ip_address}.
        slots:
          ip_address: requestBody.ip_address
      - text: Delete IP Auth {ip_address} from subaccount {subaccount_id}.
        slots:
          ip_address: requestBody.ip_address
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ip_auth/view'].post
  update:
    x-apievangelist-phrasing:
      intent: View IP Auth entries
      effect: read
      questions:
      - Which IP addresses are set up for IP authentication on my account?
      - Can I see the settings for a single IP Auth entry?
      instructions:
      - text: List all IP Auth entries.
      - text: Show details of IP Auth entry {ip_address}.
        slots:
          ip_address: requestBody.ip_address
      method: generated
      generated: '2026-10-01'