Veeva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Veeva Vault REST Workflows API

2 actions 2 updates phrasing extends openapi/veeva-workflows-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Veeva's API. It is a proposal applied on top of the contract, not a document Veeva publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/objects/documents/{documentId}/actions/{actionName}'].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 Veeva Vault REST Workflows API
  version: 1.0.0
extends: openapi/veeva-workflows-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: 1
- target: $.paths['/objects/documents/{documentId}/actions/{actionName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a document through its lifecycle workflow
      effect: write
      questions:
      - How do I send a Vault document for review as part of a workflow?
      - Can I trigger an approval or archive step on a document through the API?
      instructions:
      - text: Trigger workflow action {actionName} on Vault document {documentId}.
        slots:
          actionName: path.actionName
          documentId: path.documentId
      - text: Advance document {documentId} to the next lifecycle state by running {actionName}.
        slots:
          documentId: path.documentId
          actionName: path.actionName
      method: generated
      generated: '2026-09-26'