Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brevo eCommerce Categories API

4 actions 4 updates phrasing extends openapi/brevo-categories-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/categories'].get

$.paths['/categories'].post

$.paths['/categories/batch'].post

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 Brevo eCommerce Categories API
  version: 1.0.0
extends: openapi/brevo-categories-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: 3
- target: $.paths['/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List product categories
      effect: read
      questions:
      - Which product categories exist in my Brevo eCommerce catalog?
      - Can I fetch specific categories by ID?
      instructions:
      - text: List my product categories.
      - text: List categories with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a product category
      effect: write
      questions:
      - How do I add a single product category to the catalog?
      - Will sending an existing category ID overwrite that category?
      instructions:
      - text: Upsert category {id} named {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Save category {id} as {name} with page {url}.
        slots:
          id: requestBody.id
          name: requestBody.name
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categories/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update categories in bulk
      effect: write
      questions:
      - Can I sync many product categories in one call?
      - Is there a bulk upsert for my category tree?
      instructions:
      - text: 'Batch upsert these categories: {categories}.'
        slots:
          categories: requestBody.categories
      - text: Sync all of {categories} into the catalog at once.
        slots:
          categories: requestBody.categories
      method: generated
      generated: '2026-09-26'