BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Stores API

7 actions 7 updates phrasing extends openapi/blueconic-stores-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for BlueConic's API. It is a proposal applied on top of the contract, not a document BlueConic publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/contentStores/{contentStore}/items'].get
$.paths['/contentStores/{contentStore}/items'].put
$.paths['/contentStores'].get
$.paths['/contentStores'].post
$.paths['/contentStores/{contentStore}/items/bulk'].delete
$.paths['/contentStores/{contentStore}'].put

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 BlueConic REST API v2 Stores API
  version: 1.0.0
extends: openapi/blueconic-stores-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/contentStores/{contentStore}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List or filter items in a content store
      effect: read
      questions:
      - Which items are in one of my content stores?
      - Can I filter store items by a property, like publication date after a given day?
      instructions:
      - text: List the items in content store {contentStore}.
        slots:
          contentStore: path.contentStore
      - text: Get items in store {contentStore} matching {filterValue}.
        slots:
          contentStore: path.contentStore
          filterValue: query.filterValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contentStores/{contentStore}/items'].put
  update:
    x-apievangelist-phrasing:
      intent: Add items to a content store
      effect: write
      questions:
      - How do I load products or articles into a content store?
      - What format do items need when adding them to a store?
      instructions:
      - text: Add these items {items} to content store {contentStore}.
        slots:
          items: requestBody.items
          contentStore: path.contentStore
      - text: Upload a batch of items into store {contentStore}.
        slots:
          contentStore: path.contentStore
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contentStores'].get
  update:
    x-apievangelist-phrasing:
      intent: List all content stores
      effect: read
      questions:
      - Which content stores do we have?
      - Can I page through all content stores?
      instructions:
      - text: List all content stores.
      - text: Show {count} content stores starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contentStores'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a content store
      effect: write
      questions:
      - What's needed to set up a new content store for recommendations?
      - Can I tag a content store when creating it?
      instructions:
      - text: Create a content store named {name}.
        slots:
          name: requestBody.name
      - text: Create a new {storeType} store called {name} with description {description}.
        slots:
          storeType: requestBody.storeType
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contentStores/{contentStore}/items/bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete items from a content store
      effect: destructive
      questions:
      - How do I remove several items from a content store at once?
      - Can I delete specific store items by their IDs?
      instructions:
      - text: Delete items {ids} from content store {contentStore}.
        slots:
          ids: requestBody.ids
          contentStore: path.contentStore
      - text: Remove these items from store {contentStore}.
        slots:
          contentStore: path.contentStore
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contentStores/{contentStore}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a content store's settings
      effect: write
      questions:
      - Can I rename an existing content store?
      - Does updating a store require sending every property, or only the changes?
      instructions:
      - text: Rename content store {contentStore} to {name}.
        slots:
          contentStore: path.contentStore
          name: requestBody.name
      - text: Change the description of store {contentStore} to {description}.
        slots:
          contentStore: path.contentStore
          description: requestBody.description
      method: generated
      generated: '2026-10-01'