Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Pipelines API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/pipeline/'].get
$.paths['/pipeline/'].post
$.paths['/pipeline/{id}/'].get
$.paths['/pipeline/{id}/'].put
$.paths['/pipeline/{id}/'].delete

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 Close Pipelines API
  version: 1.0.0
extends: openapi/close-pipelines-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: 5
- target: $.paths['/pipeline/'].get
  update:
    x-apievangelist-phrasing:
      intent: List sales pipelines
      effect: read
      questions:
      - Which sales pipelines do we have?
      - What opportunity statuses belong to each pipeline?
      instructions:
      - text: List our pipelines.
      - text: Show every pipeline with its statuses.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sales pipeline
      effect: write
      questions:
      - How do I add a new pipeline for a different sales process?
      - Can I set up a separate pipeline for renewals?
      instructions:
      - text: Create a pipeline called Renewals.
      - text: Add a new sales pipeline for partner deals.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single pipeline
      effect: read
      questions:
      - How do I see the stages of one pipeline?
      - Where can I view a specific pipeline's statuses?
      instructions:
      - text: Show pipeline {id}.
        slots:
          id: path.id
      - text: Fetch the statuses in pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or reorder a pipeline
      effect: write
      questions:
      - Can I reorder the opportunity statuses in a pipeline?
      - How do I move a status from another pipeline into this one?
      instructions:
      - text: Rename pipeline {id}.
        slots:
          id: path.id
      - text: Reorder the statuses in pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an empty pipeline
      effect: destructive
      questions:
      - Why can't I delete a pipeline that still has statuses?
      - How do I remove a pipeline we stopped using?
      instructions:
      - text: Delete pipeline {id}.
        slots:
          id: path.id
      - text: Remove the empty pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'