Loops · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Loops OpenAPI Spec Event patterns API

4 actions 4 updates phrasing extends openapi/loops-event-patterns-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 4

$.info

$.paths['/v1/event-patterns'].get

$.paths['/v1/event-patterns/by-name/{eventName}'].get

$.paths['/v1/event-patterns/{eventPatternId}'].get

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 Loops OpenAPI Spec Event patterns API
  version: 1.0.0
extends: openapi/loops-event-patterns-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['/v1/event-patterns'].get
  update:
    x-apievangelist-phrasing:
      intent: List event patterns for workflow triggers
      effect: read
      questions:
      - Which events can trigger a workflow?
      - Can I page through all event patterns?
      instructions:
      - text: List the event patterns available to workflow triggers.
      - text: Show event patterns from cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/event-patterns/by-name/{eventName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an event pattern by event name
      effect: read
      questions:
      - What properties does the event named PaymentReceived carry?
      - Are event names case-sensitive when I look them up?
      instructions:
      - text: Get the event pattern for event name {eventName}.
        slots:
          eventName: path.eventName
      - text: Look up the trigger details of the {eventName} event by its name.
        slots:
          eventName: path.eventName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/event-patterns/{eventPatternId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event pattern by ID
      effect: read
      questions:
      - How do I fetch an event pattern when I only have its ID?
      - What trigger details are on a given event pattern ID?
      instructions:
      - text: Show event pattern {eventPatternId}.
        slots:
          eventPatternId: path.eventPatternId
      - text: Get details for event pattern ID {eventPatternId}.
        slots:
          eventPatternId: path.eventPatternId
      method: generated
      generated: '2026-09-26'