Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Content Types API

6 actions 6 updates phrasing extends openapi/contentstack-content-types-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 6

$.info
$.paths['/content_types'].get
$.paths['/content_types'].post
$.paths['/content_types/{content_type_uid}'].get
$.paths['/content_types/{content_type_uid}'].put
$.paths['/content_types/{content_type_uid}'].delete

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 Contentstack Content Types API
  version: 1.0.0
extends: openapi/contentstack-content-types-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: 5
- target: $.paths['/content_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List content types in a stack
      effect: read
      questions:
      - What content types are defined in my Contentstack stack?
      - Can I get a total count of content types along with the list?
      instructions:
      - text: List all content types in stack {api_key}.
        slots:
          api_key: header.api_key
      - text: Show the content types in stack {api_key} with their total count.
        slots:
          api_key: header.api_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a content type schema
      effect: write
      questions:
      - How do I define a new content type with its fields?
      - Where do I set the field schema that entries will follow?
      instructions:
      - text: Create a content type in stack {api_key} from {content_type}.
        slots:
          api_key: header.api_key
          content_type: requestBody.content_type
      - text: Add a new content model {content_type} to stack {api_key}.
        slots:
          content_type: requestBody.content_type
          api_key: header.api_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types/{content_type_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a content type's schema
      effect: read
      questions:
      - How do I see the field definitions of one content type?
      - Can I fetch an older version of a content type schema?
      instructions:
      - text: Show the schema of content type {content_type}.
        slots:
          content_type: path.content_type_uid
      - text: Get version {version} of content type {content_type}.
        slots:
          version: query.version
          content_type: path.content_type_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types/{content_type_uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a content type's schema
      effect: write
      questions:
      - Will changing a content type's schema affect entries that already exist?
      - How do I add a field to an existing content type?
      instructions:
      - text: Update content type {content_type} with schema {schema}.
        slots:
          content_type: path.content_type_uid
          schema: requestBody.content_type
      - text: Modify the fields of content type {content_type} to {schema}.
        slots:
          content_type: path.content_type_uid
          schema: requestBody.content_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types/{content_type_uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a content type
      effect: destructive
      questions:
      - Do I have to delete all entries before removing a content type?
      - How do I permanently delete a content type from a stack?
      instructions:
      - text: Delete content type {content_type}.
        slots:
          content_type: path.content_type_uid
      - text: Permanently remove content type {content_type} from stack {api_key}.
        slots:
          content_type: path.content_type_uid
          api_key: header.api_key
      method: generated
      generated: '2026-09-26'