Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Sessions API

8 actions 8 updates phrasing extends openapi/zendesk-sessions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/api/v2/sessions'].get

$.paths['/api/v2/users/{user_id}/sessions'].delete

$.paths['/api/v2/users/{user_id}/sessions/{session_id}'].get

$.paths['/api/v2/users/{user_id}/sessions/{session_id}'].delete

$.paths['/api/v2/users/me/logout'].delete

$.paths['/api/v2/users/me/session'].get

$.paths['/api/v2/users/me/session/renew'].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 Zendesk Sessions API
  version: 1.0.0
extends: openapi/zendesk-sessions-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: 7
- target: $.paths['/api/v2/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List sessions
      effect: read
      questions:
      - Can an admin see every active session across the account?
      - What sessions does an agent see when listing sessions?
      instructions:
      - text: List all sessions in the account.
      - text: Show the active login sessions I can see.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/sessions'].delete
  update:
    x-apievangelist-phrasing:
      intent: End all of a user's sessions
      effect: destructive
      questions:
      - How do I sign a user out of every device at once?
      - Can I revoke all sessions for one user after a suspected compromise?
      instructions:
      - text: Delete every session belonging to that user.
      - text: Sign this user out everywhere by ending all their sessions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/sessions/{session_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a user's session
      effect: read
      questions:
      - Can I inspect one specific session of a user?
      - What details are stored for a single login session?
      instructions:
      - text: Show one session of that user by session ID.
      - text: Fetch the details of a particular user session.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/sessions/{session_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: End one of a user's sessions
      effect: destructive
      questions:
      - Can I terminate a single session without logging the user out elsewhere?
      - Who can delete an individual session?
      instructions:
      - text: End that single session for the user.
      - text: Delete one specific login session of the user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/me/logout'].delete
  update:
    x-apievangelist-phrasing:
      intent: Log out the current session
      effect: destructive
      questions:
      - Can my Zendesk app log the current user out of their own session?
      - Why does logging out have no effect when I use OAuth or basic auth?
      instructions:
      - text: Log me out of my current session.
      - text: Delete the session my app is authenticated with.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/me/session'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the current session
      effect: read
      questions:
      - What session am I currently authenticated with?
      - Can I see details about my own active session?
      instructions:
      - text: Show my currently authenticated session.
      - text: Get the details of the session I'm using now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/me/session/renew'].get
  update:
    x-apievangelist-phrasing:
      intent: Renew the current session
      effect: read
      questions:
      - Can I keep my session alive by renewing it?
      - Is there a call to extend the session I'm signed in with?
      instructions:
      - text: Renew my current session.
      - text: Extend the session I'm signed in with before it expires.
      method: generated
      generated: '2026-09-26'