Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Deal Guidance Dimension Set Members API

8 actions 8 updates phrasing extends openapi/conga-deal-guidance-dimension-set-members-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 8

$.info
$.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions'].get
$.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions'].post
$.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions'].delete
$.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions'].patch
$.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions/{Id}'].get
$.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions/{Id}'].delete
$.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions/{Id}'].patch

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 Administration Deal Guidance Dimension Set Members API
  version: 1.0.0
extends: openapi/conga-deal-guidance-dimension-set-members-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: 7
- target: $.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the dimensions in a deal guidance dimension set
      effect: read
      questions:
      - Which dimensions make up a deal guidance dimension set?
      - Can I filter and page through the members of a dimension set?
      instructions:
      - text: List the dimensions in deal guidance dimension set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show {limit} members of dimension set {ParentId} matching {filter}.
        slots:
          limit: query.limit
          ParentId: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add dimensions to a deal guidance dimension set
      effect: write
      questions:
      - How do I add new dimensions to a deal guidance dimension set?
      - Can I create several dimension set members in one request?
      instructions:
      - text: Add new dimensions to deal guidance dimension set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Create a batch of members under dimension set {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several dimensions from a dimension set
      effect: destructive
      questions:
      - Can I remove multiple dimensions from a dimension set at once?
      - What call bulk-deletes deal guidance dimension set members?
      instructions:
      - text: Bulk-delete the listed dimensions from dimension set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove several members from deal guidance dimension set {ParentId} in one call.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several dimensions in a dimension set
      effect: write
      questions:
      - Can I edit many dimension set members in one batch?
      - Is there a bulk update for the dimensions of a deal guidance set?
      instructions:
      - text: Bulk-update dimensions in deal guidance dimension set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply changes to multiple members of dimension set {ParentId} at once.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one dimension from a dimension set
      effect: read
      questions:
      - What are the details of a single dimension in a deal guidance set?
      - How do I fetch one dimension set member by ID?
      instructions:
      - text: Fetch dimension {Id} from deal guidance dimension set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show the single member record {Id} of dimension set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one dimension from a dimension set
      effect: destructive
      questions:
      - Can I drop just one dimension from a deal guidance dimension set?
      - Which call deletes a single dimension set member by ID?
      instructions:
      - text: Delete dimension {Id} from dimension set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only member {Id} from deal guidance dimension set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimension-sets/{ParentId}/dimensions/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one dimension in a dimension set
      effect: write
      questions:
      - Can I change a single dimension in a deal guidance dimension set?
      - Which call edits one dimension set member without touching the rest?
      instructions:
      - text: Update dimension {Id} in deal guidance dimension set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit only member record {Id} of dimension set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'