Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Approvals User Dashboard API

5 actions 5 updates phrasing extends openapi/conga-userdashboard-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 5

$.info

$.paths['/v1/user-dashboard/approvals-count'].get

$.paths['/v1/user-dashboard/approvals-status'].get

$.paths['/v1/user-dashboard/getdata'].post

$.paths['/v1/user-dashboard/{businessObject}/approvals-count'].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 Approvals User Dashboard API
  version: 1.0.0
extends: openapi/conga-userdashboard-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: 4
- target: $.paths['/v1/user-dashboard/approvals-count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count the user's approvals
      effect: read
      questions:
      - How many approvals are waiting for me overall?
      - Can I filter my approval count?
      instructions:
      - text: Count my approvals.
      - text: Count my approvals matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/user-dashboard/approvals-status'].get
  update:
    x-apievangelist-phrasing:
      intent: List my approval requests by status
      effect: read
      questions:
      - Which approval requests of mine are in a given status?
      - Can I list just my approved requests along with a total?
      instructions:
      - text: List my approval requests with status {status}.
        slots:
          status: query.status
      - text: Show {status} approval requests matching {filter}.
        slots:
          status: query.status
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/user-dashboard/getdata'].post
  update:
    x-apievangelist-phrasing:
      intent: Get dashboard approval data for a business object
      effect: read
      questions:
      - Can I get approval counts by status plus the records for one business object?
      - Is there a way to fetch only the dashboard counts without records?
      instructions:
      - text: Get dashboard approval data for {BusinessObject}.
        slots:
          BusinessObject: requestBody.BusinessObject
      - text: Fetch dashboard counts only for {BusinessObject}, count-only {DashboardCountOnly}.
        slots:
          BusinessObject: requestBody.BusinessObject
          DashboardCountOnly: requestBody.DashboardCountOnly
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/user-dashboard/{businessObject}/approvals-count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count approvals for one business object
      effect: read
      questions:
      - How many approvals are there for a specific object type?
      - What is the approval count for agreements on my dashboard?
      instructions:
      - text: Count approvals for {businessObject}.
        slots:
          businessObject: path.businessObject
      - text: Get the dashboard approval count on the {businessObject} object.
        slots:
          businessObject: path.businessObject
      method: generated
      generated: '2026-10-01'