AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Roles API

2 actions 2 updates phrasing extends openapi/aftership-roles-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/roles'].get

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 Overview Roles API
  version: 1.0.0
extends: openapi/aftership-roles-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List available member roles
      effect: read
      questions:
      - Which roles can I assign to members of my organization?
      - What roles exist in my AfterShip account?
      instructions:
      - text: List the available roles.
      - text: Show me every role I can give a teammate.
      method: generated
      generated: '2026-09-26'