Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Forms API

3 actions 3 updates phrasing extends openapi/close-forms-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 3

$.info

$.paths['/form/'].get

$.paths['/form/{id}/'].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 Close Forms API
  version: 1.0.0
extends: openapi/close-forms-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: 2
- target: $.paths['/form/'].get
  update:
    x-apievangelist-phrasing:
      intent: List forms
      effect: read
      questions:
      - Which forms does my organization have?
      - Can I list forms including archived ones?
      instructions:
      - text: List all forms.
      - text: Show forms where archived is {is_archived}.
        slots:
          is_archived: query.is_archived
      method: generated
      generated: '2026-09-26'
- target: $.paths['/form/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a form and its fields
      effect: read
      questions:
      - What fields are on a specific form?
      - Can I retrieve one form by id?
      instructions:
      - text: Fetch form {id}.
        slots:
          id: path.id
      - text: Show the published fields of form {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'