Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Custom Object Types API

6 actions 6 updates phrasing extends openapi/close-custom-object-types-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['/custom_object_type/'].get

$.paths['/custom_object_type/'].post

$.paths['/custom_object_type/{id}/'].get

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

$.paths['/custom_object_type/{id}/'].delete

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 Custom Object Types API
  version: 1.0.0
extends: openapi/close-custom-object-types-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['/custom_object_type/'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom object types
      effect: read
      questions:
      - What custom object types have we defined?
      - Can I see which fields point back to each custom object type?
      instructions:
      - text: List our custom object types.
      - text: Show all custom object types with their fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_object_type/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom object type
      effect: write
      questions:
      - How do I define a new custom object like Subscriptions or Properties?
      - Which fields are required when creating a custom object type?
      instructions:
      - text: Create a custom object type named Property with plural Properties.
      - text: Define a new custom object type for tracking contracts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_object_type/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom object type
      effect: read
      questions:
      - How do I look up one custom object type's fields?
      - Where can I see a single custom object type's details?
      instructions:
      - text: Show custom object type {id}.
        slots:
          id: path.id
      - text: Fetch the definition of custom object type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_object_type/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object type
      effect: write
      questions:
      - Can I rename a custom object type or change its plural name?
      - Can I restrict which roles edit a custom object type?
      instructions:
      - text: Rename custom object type {id}.
        slots:
          id: path.id
      - text: Change the description of custom object type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_object_type/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object type
      effect: destructive
      questions:
      - Can I permanently delete a custom object type?
      - What's the way to remove a custom object type?
      instructions:
      - text: Delete custom object type {id}.
        slots:
          id: path.id
      - text: Permanently remove custom object type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'