Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Brand Kit Management Brand Kits API

6 actions 6 updates phrasing extends openapi/contentstack-brand-kits-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['/v1/brand-kits'].get
$.paths['/v1/brand-kits'].post
$.paths['/v1/brand-kits/{brand_kit_uid}'].get
$.paths['/v1/brand-kits/{brand_kit_uid}'].put
$.paths['/v1/brand-kits/{brand_kit_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 Brand Kit Management Brand Kits API
  version: 1.0.0
extends: openapi/contentstack-brand-kits-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['/v1/brand-kits'].get
  update:
    x-apievangelist-phrasing:
      intent: List Brand Kits
      effect: read
      questions:
      - Which Brand Kits exist in my Contentstack organization?
      - Can I page through Brand Kits with skip and limit?
      instructions:
      - text: List the Brand Kits in organization {org}.
        slots:
          org: header.organization_uid
      - text: Show {limit} Brand Kits in org {org} after skipping {skip}.
        slots:
          limit: query.limit
          org: header.organization_uid
          skip: query.skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-kits'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Brand Kit
      effect: write
      questions:
      - How do I set up a Brand Kit for AI content generation?
      - Can I add a description when creating a Brand Kit?
      instructions:
      - text: Create a Brand Kit named {name} in organization {org}.
        slots:
          name: requestBody.name
          org: header.organization_uid
      - text: Create Brand Kit {name} in org {org} described as {description}.
        slots:
          name: requestBody.name
          org: header.organization_uid
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-kits/{brand_kit_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Brand Kit
      effect: read
      questions:
      - How do I view the full brand identity settings of one Brand Kit?
      - What voice profiles and knowledge vault content belong to a Brand Kit?
      instructions:
      - text: Show Brand Kit {brand_kit} in organization {org}.
        slots:
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      - text: Get the brand identity configuration of Brand Kit {brand_kit} for org {org}.
        slots:
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-kits/{brand_kit_uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Brand Kit
      effect: write
      questions:
      - Can I rename an existing Brand Kit?
      - How do I change a Brand Kit's description?
      instructions:
      - text: Rename Brand Kit {brand_kit} in org {org} to {name}.
        slots:
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
          name: requestBody.name
      - text: Update Brand Kit {brand_kit} in org {org} with name {name} and description {description}.
        slots:
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-kits/{brand_kit_uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Brand Kit
      effect: destructive
      questions:
      - Does deleting a Brand Kit also remove its voice profiles?
      - How do I permanently remove a Brand Kit?
      instructions:
      - text: Delete Brand Kit {brand_kit} from organization {org}.
        slots:
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      - text: Permanently remove Brand Kit {brand_kit} and its knowledge vault in org {org}.
        slots:
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      method: generated
      generated: '2026-09-26'