Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Content Management Users API

3 actions 3 updates phrasing extends openapi/contentstack-users-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'].get

$.paths['/user'].put

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 Users API
  version: 1.0.0
extends: openapi/contentstack-users-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'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my user profile
      effect: read
      questions:
      - Which organizations does my Contentstack account belong to?
      - How do I see my own profile details?
      instructions:
      - text: Show my user profile.
      - text: Get my account details and organization memberships.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my user profile
      effect: write
      questions:
      - How do I change my first or last name on my account?
      - Can I update my own profile through the API?
      instructions:
      - text: Update my profile with {user}.
        slots:
          user: requestBody.user
      - text: Change my account name details to {user}.
        slots:
          user: requestBody.user
      method: generated
      generated: '2026-09-26'