# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for X-Author Fields API
  version: 1.0.0
extends: openapi/conga-fields-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: 5
- target: $.paths['/api/xauthor/v1/fields/data/fetch'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch locale-formatted field values for documents
      effect: read
      questions:
      - Can I fetch formatted field values for several document objects?
      - How do I get values for a document's objects in its locale?
      instructions:
      - text: Fetch field values for objects {objects} in locale {locale}.
        slots:
          objects: requestBody.documentObjects
          locale: requestBody.documentLocale
      - text: Fetch formatted data for document objects {objects}.
        slots:
          objects: requestBody.documentObjects
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/fields/data/retrieve'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve field data
      effect: read
      questions:
      - Can I retrieve raw field data for a set of requests?
      - How do I get values for several field data requests at once?
      instructions:
      - text: Retrieve field data for requests {requests}.
        slots:
          requests: requestBody.fieldDataRequests
      - text: 'Get the data for these field requests: {requests}.'
        slots:
          requests: requestBody.fieldDataRequests
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/fields/references/metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve field name references
      effect: read
      questions:
      - How do I find what a field reference points to?
      - Can I resolve reference metadata to a field name?
      instructions:
      - text: Resolve field references for org type {org}.
        slots:
          org: header.OrgType
      - text: Look up the field names behind reference metadata.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/fields/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate field data in a document
      effect: read
      questions:
      - Are the field values in my document valid?
      - Can I validate document field data for a locale?
      instructions:
      - text: Validate the fields in document content {content}.
        slots:
          content: requestBody.documentContent
      - text: Check field data in {content} for locale {locale}.
        slots:
          content: requestBody.documentContent
          locale: requestBody.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/fields/validate/v2'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate field data with v2 metadata
      effect: read
      questions:
      - Is there a v2 field validation that uses document metadata?
      - Can I validate fields against validation contexts?
      instructions:
      - text: Validate fields with contexts {contexts} using v2 metadata.
        slots:
          contexts: requestBody.fieldValidationContexts
      - text: Run v2 field validation on document metadata {meta}.
        slots:
          meta: requestBody.documentMetadata
      method: generated
      generated: '2026-10-01'