Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Schema Manager Index Definition API

3 actions 3 updates phrasing extends openapi/conga-index-definition-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 3

$.info
$.paths['/api/schema/v1/objects/{objectName}/indexes'].post
$.paths['/api/schema/v1/objects/{objectName}/indexes/{indexFieldName}'].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 Schema Manager Index Definition API
  version: 1.0.0
extends: openapi/conga-index-definition-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: 2
- target: $.paths['/api/schema/v1/objects/{objectName}/indexes'].post
  update:
    x-apievangelist-phrasing:
      intent: Index a field on an object
      effect: write
      questions:
      - How do I add an index to speed up queries on a field?
      - Can I index a custom field?
      instructions:
      - text: Index field {field} on object {object}.
        slots:
          field: requestBody.FieldName
          object: path.objectName
      - text: Create an index on {object} for {field}.
        slots:
          object: path.objectName
          field: requestBody.FieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/indexes/{indexFieldName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field index
      effect: destructive
      questions:
      - Can I drop an index I no longer need?
      - What happens to queries when an index is removed?
      instructions:
      - text: Delete the index on {field} of object {object}.
        slots:
          field: path.indexFieldName
          object: path.objectName
      - text: Drop index {field} from {object}.
        slots:
          field: path.indexFieldName
          object: path.objectName
      method: generated
      generated: '2026-10-01'