Loops · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Loops OpenAPI Spec Campaign groups API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/campaign-groups'].get
$.paths['/v1/campaign-groups'].post
$.paths['/v1/campaign-groups/{campaignGroupId}'].get
$.paths['/v1/campaign-groups/{campaignGroupId}'].post

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 Loops OpenAPI Spec Campaign groups API
  version: 1.0.0
extends: openapi/loops-campaign-groups-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: 4
- target: $.paths['/v1/campaign-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaign groups
      effect: read
      questions:
      - Which groups are my campaigns organized into?
      - Can I page through campaign groups most recent first?
      instructions:
      - text: List my campaign groups.
      - text: Show {perPage} campaign groups per page starting at cursor {cursor}.
        slots:
          perPage: query.perPage
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/campaign-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a campaign group
      effect: write
      questions:
      - How do I make a new folder to organize campaigns?
      - Can I name a new campaign group Unsorted?
      instructions:
      - text: Create a campaign group called {name}.
        slots:
          name: requestBody.name
      - text: Add a campaign group {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/campaign-groups/{campaignGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign group
      effect: read
      questions:
      - How do I see the details of a single campaign group?
      - What is the description on a given campaign group?
      instructions:
      - text: Show campaign group {campaignGroupId}.
        slots:
          campaignGroupId: path.campaignGroupId
      - text: Fetch the name and description of campaign group {campaignGroupId}.
        slots:
          campaignGroupId: path.campaignGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/campaign-groups/{campaignGroupId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a campaign group
      effect: write
      questions:
      - How do I rename an existing campaign group?
      - Can I edit the reserved Unsorted campaign group?
      instructions:
      - text: Rename campaign group {campaignGroupId} to {name}.
        slots:
          campaignGroupId: path.campaignGroupId
          name: requestBody.name
      - text: Change the description of campaign group {campaignGroupId} to {description}.
        slots:
          campaignGroupId: path.campaignGroupId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'