Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Document Metadata API

6 actions 6 updates phrasing extends openapi/conga-documentmetadata-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/xauthor/v1/documents/gdocs/{gdocFileId}/metadata'].get

$.paths['/api/xauthor/v1/documents/{attachmentId}/document-properties'].get

$.paths['/api/xauthor/v1/documents/{attachmentId}/metadata'].get

$.paths['/api/xauthor/v1/documents/{attachmentId}/metadata/v2'].get

$.paths['/api/xauthor/v1/documents/{attachmentId}/smart-elements'].get

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 X-Author Document Metadata API
  version: 1.0.0
extends: openapi/conga-documentmetadata-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/documents/gdocs/{gdocFileId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get V2 metadata for a Google Doc
      effect: read
      questions:
      - How do I get the V2 metadata JSON for a document stored in Google Docs?
      - Can I read X-Author metadata from a Google Docs file?
      instructions:
      - text: Get V2 metadata for Google Doc {gdoc_file_id}.
        slots:
          gdoc_file_id: path.gdocFileId
      - text: Fetch Google Doc {gdoc_file_id} metadata JSON for org type {org_type}.
        slots:
          gdoc_file_id: path.gdocFileId
          org_type: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/documents/{attachmentId}/document-properties'].get
  update:
    x-apievangelist-phrasing:
      intent: Get document metadata with custom properties
      effect: read
      questions:
      - Which custom properties are set on a document attachment?
      - Can I get a document's metadata together with its custom properties?
      instructions:
      - text: Show the custom document properties of attachment {attachment_id}.
        slots:
          attachment_id: path.attachmentId
      - text: Get metadata and custom properties for attachment {attachment_id}.
        slots:
          attachment_id: path.attachmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/documents/{attachmentId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get document metadata
      effect: read
      questions:
      - What metadata is stored for a document attachment?
      - Can I read the original metadata of an attached document?
      instructions:
      - text: Get the document metadata for attachment {attachment_id}.
        slots:
          attachment_id: path.attachmentId
      - text: Fetch attachment {attachment_id} metadata for org type {org_type}.
        slots:
          attachment_id: path.attachmentId
          org_type: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/documents/{attachmentId}/metadata/v2'].get
  update:
    x-apievangelist-phrasing:
      intent: Get V2 metadata for an attachment
      effect: read
      questions:
      - Is there a V2 metadata JSON format for document attachments?
      - Can I get the newer V2 metadata for an attached file rather than a Google Doc?
      instructions:
      - text: Get V2 metadata JSON for attachment {attachment_id}.
        slots:
          attachment_id: path.attachmentId
      - text: Fetch the V2-format metadata of attached document {attachment_id}.
        slots:
          attachment_id: path.attachmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/documents/{attachmentId}/smart-elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields and clauses in a document
      effect: read
      questions:
      - Which merge fields and clauses are embedded in a document?
      - Can I extract the smart elements from a document's metadata?
      instructions:
      - text: List fields and clauses in attachment {attachment_id}.
        slots:
          attachment_id: path.attachmentId
      - text: Show the smart elements of document {attachment_id}.
        slots:
          attachment_id: path.attachmentId
      method: generated
      generated: '2026-10-01'