Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Approvals Rule Dimensions API

5 actions 5 updates phrasing extends openapi/conga-ruledimensions-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/rule-dimensions'].post

$.paths['/v1/rule-dimensions/{id}'].get

$.paths['/v1/rule-dimensions/{id}'].put

$.paths['/v1/rule-dimensions/{id}'].delete

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 Rule Dimensions API
  version: 1.0.0
extends: openapi/conga-ruledimensions-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/rule-dimensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an approval rule dimension
      effect: write
      questions:
      - How do I define a new dimension that approval rules can evaluate?
      - What's required to save an approval rule dimension?
      instructions:
      - text: Create a {dimensionType} rule dimension named {name} on {businessObject} from datasource {datasource}.
        slots:
          dimensionType: requestBody.DimensionType
          name: requestBody.Name
          businessObject: requestBody.BusinessObject
          datasource: requestBody.Datasource
      - text: Save a new approval rule dimension for business object {businessObject} using {datasource} as type {dimensionType}.
        slots:
          businessObject: requestBody.BusinessObject
          datasource: requestBody.Datasource
          dimensionType: requestBody.DimensionType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rule-dimensions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an approval rule dimension
      effect: read
      questions:
      - What datasource and business object does a rule dimension use?
      - Can I look up one approval rule dimension by ID?
      instructions:
      - text: Get approval rule dimension {id}.
        slots:
          id: path.id
      - text: Show the definition of rule dimension {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rule-dimensions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an approval rule dimension
      effect: write
      questions:
      - Can I change the datasource on an existing rule dimension?
      - Which fields must I resend when updating a rule dimension?
      instructions:
      - text: Point rule dimension {id} at datasource {datasource} on {businessObject} as type {dimensionType}.
        slots:
          id: path.id
          datasource: requestBody.Datasource
          businessObject: requestBody.BusinessObject
          dimensionType: requestBody.DimensionType
      - text: Update the description of existing rule dimension {id} to "{description}".
        slots:
          id: path.id
          description: requestBody.Description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rule-dimensions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an approval rule dimension
      effect: destructive
      questions:
      - Can I delete a rule dimension we no longer use in approval rules?
      - Is removing an approval rule dimension permanent?
      instructions:
      - text: Delete approval rule dimension {id}.
        slots:
          id: path.id
      - text: Remove rule dimension {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'