Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Content Management User Sessions API

3 actions 3 updates phrasing extends openapi/contentstack-user-sessions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/user-session'].post

$.paths['/user-session'].delete

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 Contentstack Content Management User Sessions API
  version: 1.0.0
extends: openapi/contentstack-user-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: 2
- target: $.paths['/user-session'].post
  update:
    x-apievangelist-phrasing:
      intent: Log in and get an authtoken
      effect: write
      questions:
      - How do I get an authtoken with my email and password?
      - What do I call to sign in to the Contentstack Management API?
      instructions:
      - text: Log me in with credentials {user}.
        slots:
          user: requestBody.user
      - text: Sign in as {user} and return an authtoken.
        slots:
          user: requestBody.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user-session'].delete
  update:
    x-apievangelist-phrasing:
      intent: Log out and invalidate the authtoken
      effect: destructive
      questions:
      - How do I invalidate my current authtoken?
      - Does logging out end all my Contentstack sessions?
      instructions:
      - text: Log me out.
      - text: Sign out and revoke my current authtoken.
      method: generated
      generated: '2026-09-26'