Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Documents API

10 actions 10 updates phrasing extends openapi/act-documents-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 10

$.info

$.paths['/api/companies/{id}/documents'].get

$.paths['/api/contacts/{id}/documents'].get

$.paths['/api/groups/{id}/documents'].get

$.paths['/api/opportunities/{id}/documents'].get

$.paths['/api/Documents/{id}'].get

$.paths['/api/Documents/{id}'].put

$.paths['/api/Documents/{id}'].delete

$.paths['/api/Documents'].get

$.paths['/api/Documents'].post

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 act.web.api Documents API
  version: 1.0.0
extends: openapi/act-documents-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: 9
- target: $.paths['/api/companies/{id}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's documents
      effect: read
      questions:
      - Which documents are attached to a company?
      - Can I include documents from the company's contacts too?
      instructions:
      - text: List documents for company {id}.
        slots:
          id: path.id
      - text: List documents for company {id} with scope {showFor}.
        slots:
          id: path.id
          showFor: query.showFor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contacts/{id}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a contact's documents
      effect: read
      questions:
      - What documents are on file for a contact?
      - Can I filter a contact's documents with an OData query?
      instructions:
      - text: List documents for contact {id}.
        slots:
          id: path.id
      - text: Show the documents attached to contact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/groups/{id}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's documents
      effect: read
      questions:
      - Which documents belong to a group?
      - Can I widen a group's document list to its members with a scope option?
      instructions:
      - text: List documents for group {id}.
        slots:
          id: path.id
      - text: List documents for group {id} with scope {showFor}.
        slots:
          id: path.id
          showFor: query.showFor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/opportunities/{id}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List an opportunity's documents
      effect: read
      questions:
      - What documents are attached to a sales opportunity?
      - Where can I see the proposals and files on one deal?
      instructions:
      - text: List documents for opportunity {id}.
        slots:
          id: path.id
      - text: Show the documents attached to opportunity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Documents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document
      effect: read
      questions:
      - How do I look up a single document record by ID?
      - What details are stored on one document entry?
      instructions:
      - text: Show document {id}.
        slots:
          id: path.id
      - text: Get the details of document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Documents/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a document
      effect: write
      questions:
      - How do I update an existing document record?
      - Can I change what a document is regarding after it's saved?
      instructions:
      - text: Update document {id} so it is regarding {regarding}.
        slots:
          id: path.id
          regarding: requestBody.regarding
      - text: Change the details of document {id} to {details}.
        slots:
          id: path.id
          details: requestBody.details
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Documents/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document
      effect: destructive
      questions:
      - How do I delete a document record?
      - Can I permanently remove one document by its ID?
      instructions:
      - text: Delete document {id}.
        slots:
          id: path.id
      - text: Permanently remove document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents
      effect: read
      questions:
      - Can I list every document record in the database?
      - Which documents match an OData filter?
      instructions:
      - text: List all documents.
      - text: Show every document record.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document
      effect: write
      questions:
      - How do I add a new document record?
      - Can I link a new document to contacts when I create it?
      instructions:
      - text: Create a document regarding {regarding}.
        slots:
          regarding: requestBody.regarding
      - text: Add a document regarding {regarding} for contacts {contacts}.
        slots:
          regarding: requestBody.regarding
          contacts: requestBody.contacts
      method: generated
      generated: '2026-10-01'