Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Contract Cycle Time API

7 actions 7 updates phrasing extends openapi/conga-contract-cycle-time-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 7

$.info
$.paths['/api/clm/v1/cycletimes'].post
$.paths['/api/clm/v1/cycletimes/contractfields'].get
$.paths['/api/clm/v1/cycletimes/dashboard'].get
$.paths['/api/clm/v1/cycletimes/{cycleTimeGroupId}'].get
$.paths['/api/clm/v1/cycletimes/{cycleTimeGroupId}'].put
$.paths['/api/clm/v1/cycletimes/{cycleTimeGroupId}'].delete

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 Contracts Contract Cycle Time API
  version: 1.0.0
extends: openapi/conga-contract-cycle-time-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: 6
- target: $.paths['/api/clm/v1/cycletimes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cycle-time group
      effect: write
      questions:
      - How do I define a new cycle-time group that measures time between two contract field values?
      - Which values are required to set up a cycle-time group record?
      instructions:
      - text: Create cycle-time group {name} measuring {field_label} from {from_value} to {to_value}.
        slots:
          name: requestBody.Name
          field_label: requestBody.FieldLabel
          from_value: requestBody.FromValue
          to_value: requestBody.ToValue
      - text: Add an inactive cycle-time group named {name}.
        slots:
          name: requestBody.Name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/cycletimes/contractfields'].get
  update:
    x-apievangelist-phrasing:
      intent: List contract fields for cycle-time tracking
      effect: read
      questions:
      - Which contract fields can be used when building a cycle-time group?
      - What contract object metadata is available for cycle-time measurement?
      instructions:
      - text: List the contract fields I can use in a cycle-time group.
      - text: Show the contract object metadata available for cycle times.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/cycletimes/dashboard'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cycle-time dashboard data
      effect: read
      questions:
      - How long have contracts spent in each status over the past 12 months?
      - Is there a dashboard view of cycle-time data by status category?
      instructions:
      - text: Show the cycle-time dashboard for the last 12 months.
      - text: Get cycle-time data by status category and status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/cycletimes/{cycleTimeGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cycle-time group
      effect: read
      questions:
      - What's configured on one particular cycle-time group?
      - Can I fetch a cycle-time group record by its ID?
      instructions:
      - text: Show cycle-time group {group_id}.
        slots:
          group_id: path.cycleTimeGroupId
      - text: Get the from and to values of cycle-time group {group_id}.
        slots:
          group_id: path.cycleTimeGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/cycletimes/{cycleTimeGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a cycle-time group
      effect: write
      questions:
      - Can I change the start and end values a cycle-time group measures?
      - Is it possible to deactivate an existing cycle-time group?
      instructions:
      - text: Update cycle-time group {group_id} to measure from {from_value} to {to_value}.
        slots:
          group_id: path.cycleTimeGroupId
          from_value: requestBody.FromValue
          to_value: requestBody.ToValue
      - text: Rename cycle-time group {group_id} to {name}.
        slots:
          group_id: path.cycleTimeGroupId
          name: requestBody.Name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/cycletimes/{cycleTimeGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a cycle-time group
      effect: destructive
      questions:
      - How do I remove a cycle-time group I no longer need?
      - Will deleting a cycle-time group record be permanent?
      instructions:
      - text: Delete cycle-time group {group_id}.
        slots:
          group_id: path.cycleTimeGroupId
      - text: Remove the cycle-time group record {group_id}.
        slots:
          group_id: path.cycleTimeGroupId
      method: generated
      generated: '2026-10-01'