SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Scopes API

5 actions 5 updates phrasing extends openapi/sendgrid-scopes-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 5

$.info

$.paths['/v3/scopes'].get

$.paths['/v3/scopes/requests'].get

$.paths['/v3/scopes/requests/{request_id}'].delete

$.paths['/v3/scopes/requests/{request_id}/approve'].patch

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 Scopes API
  version: 1.0.0
extends: openapi/sendgrid-scopes-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: 4
- target: $.paths['/v3/scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the scopes this user can access
      effect: read
      questions:
      - Which API permissions does my current key or user actually have?
      - Why am I getting 403s, and which scopes am I missing?
      instructions:
      - text: List all scopes I have access to.
      - text: Show the permissions granted to this user.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/scopes/requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List teammate access requests
      effect: read
      questions:
      - Which teammates have asked for extra access recently?
      - Can I page through pending access requests?
      instructions:
      - text: List recent access requests from teammates.
      - text: Show {limit} access requests starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/scopes/requests/{request_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deny a teammate's access request
      effect: destructive
      questions:
      - How do I reject a teammate's request for more permissions?
      - Who is allowed to deny an access request?
      instructions:
      - text: Deny access request {request_id}.
        slots:
          request_id: path.request_id
      - text: Reject the teammate access attempt {request_id}.
        slots:
          request_id: path.request_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/scopes/requests/{request_id}/approve'].patch
  update:
    x-apievangelist-phrasing:
      intent: Approve a teammate's access request
      effect: write
      questions:
      - Can I grant a teammate the access they requested?
      - Must I be a teammate admin to approve access requests?
      instructions:
      - text: Approve access request {request_id}.
        slots:
          request_id: path.request_id
      - text: Grant the permissions asked for in request {request_id}.
        slots:
          request_id: path.request_id
      method: generated
      generated: '2026-09-24'