Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry System Members API

11 actions 11 updates phrasing extends openapi/sentry-system-members-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Sentry's API. It is a proposal applied on top of the contract, not a document Sentry publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/organizations/{organization_id_or_slug}/members/'].get
$.paths['/organizations/{organization_id_or_slug}/members/'].post
$.paths['/organizations/{organization_id_or_slug}/members/{member_id}/'].get
$.paths['/organizations/{organization_id_or_slug}/members/{member_id}/'].put
$.paths['/organizations/{organization_id_or_slug}/members/{member_id}/'].delete
$.paths['/teams/{organization_id_or_slug}/{team_id_or_slug}/members/'].get
$.paths['/organizations/{organization_id_or_slug}/members/{member_id}/teams/{team_id_or_slug}/'].put
$.paths['/organizations/{organization_id_or_slug}/members/{member_id}/teams/{team_id_or_slug}/'].post
$.paths['/organizations/{organization_id_or_slug}/members/{member_id}/teams/{team_id_or_slug}/'].delete
$.paths['/organizations/{organization_id_or_slug}/users/{user_id}/teams/'].get

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 Sentry System Members API
  version: 1.0.0
extends: openapi/sentry-system-members-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: 10
- target: $.paths['/organizations/{organization_id_or_slug}/members/'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization members
      effect: read
      questions:
      - Who are the members of my Sentry organization?
      - Can I page through everyone in the org?
      instructions:
      - text: List members of organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show the next page of {org} members from cursor {cursor}.
        slots:
          org: path.organization_id_or_slug
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/members/'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a member by email
      effect: write
      questions:
      - How do I invite a new person to my organization?
      - Can I choose a role and teams when inviting someone?
      instructions:
      - text: Invite {email} to organization {org} as {role}.
        slots:
          email: requestBody.email
          org: path.organization_id_or_slug
          role: requestBody.role
      - text: Add {email} as {role} and put them on teams {teams}.
        slots:
          email: requestBody.email
          role: requestBody.role
          teams: requestBody.teams
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/members/{member_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization member
      effect: read
      questions:
      - What role does a specific member have?
      - Can I view one member's details by ID?
      instructions:
      - text: Show member {member_id} of organization {org}.
        slots:
          member_id: path.member_id
          org: path.organization_id_or_slug
      - text: Fetch details for org member {member_id}.
        slots:
          member_id: path.member_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/members/{member_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a member's org role or teams
      effect: write
      questions:
      - How do I promote a member to admin?
      - Can I change which teams a member belongs to in one update?
      instructions:
      - text: Change member {member_id} in {org} to org role {role}.
        slots:
          member_id: path.member_id
          org: path.organization_id_or_slug
          role: requestBody.role
      - text: Set member {member_id}'s team memberships to {teams}.
        slots:
          member_id: path.member_id
          teams: requestBody.teams
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/members/{member_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from the organization
      effect: destructive
      questions:
      - How do I remove someone who left the company?
      - What happens when a member is removed from the org?
      instructions:
      - text: Remove member {member_id} from organization {org}.
        slots:
          member_id: path.member_id
          org: path.organization_id_or_slug
      - text: Delete org member {member_id}.
        slots:
          member_id: path.member_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/teams/{organization_id_or_slug}/{team_id_or_slug}/members/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a team's members
      effect: read
      questions:
      - Who belongs to a particular team?
      - Can I see a team's membership list?
      instructions:
      - text: List members of team {team} in {org}.
        slots:
          team: path.team_id_or_slug
          org: path.organization_id_or_slug
      - text: Show who is on team {team}.
        slots:
          team: path.team_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/members/{member_id}/teams/{team_id_or_slug}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a member's role on a team
      effect: write
      questions:
      - How do I make someone a team admin?
      - Can a member have a different role on one team than another?
      instructions:
      - text: Set member {member_id}'s role on team {team} in {org} to {teamRole}.
        slots:
          member_id: path.member_id
          team: path.team_id_or_slug
          org: path.organization_id_or_slug
          teamRole: requestBody.teamRole
      - text: Make member {member_id} a {teamRole} of team {team}.
        slots:
          member_id: path.member_id
          teamRole: requestBody.teamRole
          team: path.team_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/members/{member_id}/teams/{team_id_or_slug}/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a member to a team
      effect: write
      questions:
      - How do I put an existing member on a team?
      - Can I add someone to a team without re-inviting them?
      instructions:
      - text: Add member {member_id} to team {team} in {org}.
        slots:
          member_id: path.member_id
          team: path.team_id_or_slug
          org: path.organization_id_or_slug
      - text: Put org member {member_id} on team {team}.
        slots:
          member_id: path.member_id
          team: path.team_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/members/{member_id}/teams/{team_id_or_slug}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from a team
      effect: destructive
      questions:
      - How do I take someone off a team but keep them in the org?
      - Can I drop a member from a single team?
      instructions:
      - text: Remove member {member_id} from team {team} in {org}.
        slots:
          member_id: path.member_id
          team: path.team_id_or_slug
          org: path.organization_id_or_slug
      - text: Take member {member_id} off team {team}.
        slots:
          member_id: path.member_id
          team: path.team_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/users/{user_id}/teams/'].get
  update:
    x-apievangelist-phrasing:
      intent: List the teams a user belongs to
      effect: read
      questions:
      - Which teams is a given user on?
      - Can I see all team memberships for one user in my org?
      instructions:
      - text: List teams that user {user_id} belongs to in {org}.
        slots:
          user_id: path.user_id
          org: path.organization_id_or_slug
      - text: Show user {user_id}'s teams.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'