Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Profi Orders API

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-profi-orders-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/profi-orders'].get

$.paths['/api/profi-orders/status'].get

$.paths['/api/profi-orders/ingest'].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 Live Direct Marketing Online Profi Orders API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-profi-orders-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: 3
- target: $.paths['/api/profi-orders'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the Profi.ru order feed
      effect: read
      questions:
      - What new Profi.ru orders match my keyword?
      - Can I page through collected Profi.ru client requests?
      instructions:
      - text: List Profi.ru orders matching {keyword}.
        slots:
          keyword: query.keyword
      - text: Show page {page} of Profi.ru orders for {keyword}, {pageSize} per page.
        slots:
          page: query.page
          keyword: query.keyword
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/profi-orders/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Profi.ru monitor status
      effect: read
      questions:
      - When did the Profi.ru monitor last ingest orders?
      - How many orders has each tracked keyword picked up?
      instructions:
      - text: Show the Profi.ru monitor status.
      - text: Report the last ingest time and per-keyword counts for the order monitor.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/profi-orders/ingest'].post
  update:
    x-apievangelist-phrasing:
      intent: Push orders from the Profi.ru monitor
      effect: write
      questions:
      - How does the external monitor send scraped Profi.ru orders in?
      - Where does the order watcher deliver new Profi.ru requests?
      instructions:
      - text: Ingest a batch of orders from the Profi.ru monitor.
      - text: Deliver newly scraped Profi.ru orders into the feed.
      method: generated
      generated: '2026-10-01'