Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ingress Composer Parameter API

3 actions 3 updates phrasing extends openapi/conga-composerparameter-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['/v1/Parameter'].get

$.paths['/v1/Parameter/{id}'].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 Ingress Composer Parameter API
  version: 1.0.0
extends: openapi/conga-composerparameter-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['/v1/Parameter'].get
  update:
    x-apievangelist-phrasing:
      intent: List Composer parameters
      effect: read
      questions:
      - Which Composer parameters are available?
      - Can I search parameters by name with paging?
      instructions:
      - text: List Composer parameters.
      - text: Find parameters named like {searchName}.
        slots:
          searchName: query.searchName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Parameter/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Composer parameter
      effect: read
      questions:
      - What does a specific Composer parameter do?
      - Can I look up one parameter by ID?
      instructions:
      - text: Show Composer parameter {id}.
        slots:
          id: path.id
      - text: Get the details of parameter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'