Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Token API

4 actions 4 updates phrasing extends openapi/conga-token-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 4

$.info
$.paths['/api/xauthor/v1/google-token'].get
$.paths['/api/xauthor/v1/sites/{siteName}/validate'].get
$.paths['/api/xauthor/v1/token'].post

OpenAPI Overlay

Raw ↑ 
# 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 Token API
  version: 1.0.0
extends: openapi/conga-token-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: 3
- target: $.paths['/api/xauthor/v1/google-token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Google auth token for X-Author
      effect: read
      questions:
      - Where does X-Author get the token it uses to talk to Google APIs?
      - Can I fetch a Google authentication token for the Google Docs integration?
      instructions:
      - text: Fetch the Google authentication token for my {OrgType} org.
        slots:
          OrgType: header.OrgType
      - text: Get a Google access token so X-Author can call Google APIs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/sites/{siteName}/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that a SharePoint site is valid
      effect: read
      questions:
      - Can I verify a custom SharePoint site name before X-Author uses it?
      - How do I tell whether the SharePoint site I created is valid?
      instructions:
      - text: Validate SharePoint site {siteName}.
        slots:
          siteName: path.siteName
      - text: Check whether {siteName} is a valid SharePoint site for my {OrgType} org.
        slots:
          siteName: path.siteName
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange credentials for an X-Author auth token
      effect: write
      questions:
      - What do I send to get an X-Author access token using a client ID and secret?
      - Can I trade an authorization code and redirect URI for an auth token?
      instructions:
      - text: Get an auth token with client ID {clientId} and secret {clientSecret}.
        slots:
          clientId: requestBody.clientId
          clientSecret: requestBody.clientSecret
      - text: Exchange authorization code {code} for a token using redirect URI {redirectURI}.
        slots:
          code: requestBody.code
          redirectURI: requestBody.redirectURI
      - text: Request an X-Author token for my {OrgType} org with scope {scope}.
        slots:
          OrgType: header.OrgType
          scope: requestBody.scope
      method: generated
      generated: '2026-10-01'