Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Organizations API

3 actions 3 updates phrasing extends openapi/close-organizations-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['/organization/{id}/'].get

$.paths['/organization/{id}/'].put

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 Organizations API
  version: 1.0.0
extends: openapi/close-organizations-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['/organization/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get organization details
      effect: read
      questions:
      - Who are the active and inactive members of our organization?
      - Can I get nested user objects for organization memberships?
      instructions:
      - text: Show organization {id}.
        slots:
          id: path.id
      - text: Get organization {id} expanding {expand}.
        slots:
          id: path.id
          expand: query._expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update organization settings
      effect: write
      questions:
      - How do I change our organization's default currency?
      - Can I require an unsubscribe link in all emails?
      instructions:
      - text: Set the currency of organization {id} to {currency}.
        slots:
          id: path.id
          currency: requestBody.currency
      - text: Rename organization {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'