Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ExternalEndpointConfiguration External Endpoint Auth…

5 actions 5 updates phrasing extends openapi/conga-external-endpoint-auth-credentials-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['/api/external-endpoint-config/v1/credentials'].put
$.paths['/api/external-endpoint-config/v1/credentials'].post
$.paths['/api/external-endpoint-config/v1/credentials/{name}'].get
$.paths['/api/external-endpoint-config/v1/credentials/{name}'].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 ExternalEndpointConfiguration External Endpoint Auth…
  version: 1.0.0
extends: openapi/conga-external-endpoint-auth-credentials-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['/api/external-endpoint-config/v1/credentials'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an endpoint auth credential
      effect: write
      questions:
      - How do I change the secrets on an existing external auth configuration?
      - Can I switch a saved credential to a different auth type?
      instructions:
      - text: Update auth configuration {name} to use auth type {type}.
        slots:
          name: requestBody.Name
          type: requestBody.AuthType
      - text: Replace the basic auth secrets on existing credential {name} with {secrets}.
        slots:
          name: requestBody.Name
          secrets: requestBody.BasicAuthSecrets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/external-endpoint-config/v1/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an endpoint auth credential
      effect: write
      questions:
      - How do I store new credentials for calling an external endpoint?
      - Which auth types can a new credential configuration use?
      instructions:
      - text: Create a new auth configuration named {name} of type {type}.
        slots:
          name: requestBody.Name
          type: requestBody.AuthType
      - text: Save new OAuth client secrets {secrets} as credential {name}.
        slots:
          secrets: requestBody.OAuthClientSecrets
          name: requestBody.Name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/external-endpoint-config/v1/credentials/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint auth credential
      effect: read
      questions:
      - Can I look up a saved authentication configuration by name?
      - What auth type does a stored credential use?
      instructions:
      - text: Get auth configuration {name}.
        slots:
          name: path.name
      - text: Show the credential settings called {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/external-endpoint-config/v1/credentials/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an endpoint auth credential
      effect: destructive
      questions:
      - How do I remove stored credentials for an external endpoint?
      - Can I delete an authentication configuration by name?
      instructions:
      - text: Delete auth configuration {name}.
        slots:
          name: path.name
      - text: Remove the stored credential {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'