# 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 Objects API
  version: 1.0.0
extends: openapi/veeva-objects-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['/vobjects/{objectName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List records of a Vault object
      effect: read
      questions:
      - How do I list all the study or product records stored in a Vault object?
      - Can I choose which fields come back when listing object records?
      instructions:
      - text: List the records of the {objectName} object.
        slots:
          objectName: path.objectName
      - text: List {objectName} records returning only the fields {fields}, {limit} at a time.
        slots:
          objectName: path.objectName
          fields: query.fields
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vobjects/{objectName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Vault object record
      effect: write
      questions:
      - How do I add a new site or product record to a Vault object?
      - Can I create a record on a custom Vault object through the API?
      instructions:
      - text: Create a new record on the {objectName} object.
        slots:
          objectName: path.objectName
      - text: Add a new {objectName} record to the vault.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vobjects/{objectName}/{recordId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Vault object record
      effect: read
      questions:
      - How do I look up a single object record in Vault by its ID?
      - What field values does a specific study record currently hold?
      instructions:
      - text: Get record {recordId} from the {objectName} object.
        slots:
          recordId: path.recordId
          objectName: path.objectName
      - text: Show me the details of {objectName} record {recordId}.
        slots:
          objectName: path.objectName
          recordId: path.recordId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vobjects/{objectName}/{recordId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update fields on a Vault object record
      effect: write
      questions:
      - How do I change field values on an existing Vault object record?
      - Can I edit a product record that is already in the vault?
      instructions:
      - text: Update the fields on {objectName} record {recordId}.
        slots:
          objectName: path.objectName
          recordId: path.recordId
      - text: Edit existing record {recordId} of object {objectName}.
        slots:
          recordId: path.recordId
          objectName: path.objectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vobjects/{objectName}/{recordId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Vault object record
      effect: destructive
      questions:
      - How do I remove an object record from Vault?
      - Can I delete a site record that was created by mistake?
      instructions:
      - text: Delete record {recordId} from the {objectName} object.
        slots:
          recordId: path.recordId
          objectName: path.objectName
      - text: Remove {objectName} record {recordId} from the vault.
        slots:
          objectName: path.objectName
          recordId: path.recordId
      method: generated
      generated: '2026-09-26'