Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Document Types API

5 actions 5 updates phrasing extends openapi/act-document-types-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Act! CRM's API. It is a proposal applied on top of the contract, not a document Act! CRM publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/documents/history-types'].get
$.paths['/api/documents/historytypes'].get
$.paths['/api/documents/history-types/{name}'].get
$.paths['/api/documents/historytypes/{name}'].get

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 act.web.api Document Types API
  version: 1.0.0
extends: openapi/act-document-types-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/api/documents/history-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List document history types
      effect: read
      questions:
      - What history types can documents be logged under?
      - Which endpoint lists the current document history types?
      instructions:
      - text: List all document history types.
      - text: Show the document history types from the current endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/documents/historytypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List document history types (deprecated)
      effect: read
      questions:
      - Is the old historytypes endpoint for documents still available?
      - What does the deprecated library document history types call return?
      instructions:
      - text: List document history types using the deprecated historytypes endpoint.
      - text: Call the legacy library document history types list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/documents/history-types/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document history type by name
      effect: read
      questions:
      - Can I look up one document history type by its name?
      - What does a named document history type contain?
      instructions:
      - text: Get document history type {name}.
        slots:
          name: path.name
      - text: Show the document history type called {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/documents/historytypes/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document history type by name (deprecated)
      effect: read
      questions:
      - Does the deprecated historytypes-by-name lookup still work?
      - Which legacy endpoint fetched a single library document history type?
      instructions:
      - text: Get document history type {name} from the deprecated endpoint.
        slots:
          name: path.name
      - text: Use the legacy lookup for library history type {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'