# 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…
  version: 1.0.0
extends: openapi/conga-external-endpoint-configuration-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/external-endpoint-config/v1/endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List external endpoint configurations
      effect: read
      questions:
      - Which external endpoints have we configured?
      - Can I see every endpoint configuration at once?
      instructions:
      - text: List all external endpoint configurations.
      - text: Show every configured external endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/external-endpoint-config/v1/endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an external endpoint configuration
      effect: write
      questions:
      - How do I register a new external endpoint to call?
      - Can I attach saved credentials when defining an endpoint?
      instructions:
      - text: Create endpoint {name} calling {url} with method {method}.
        slots:
          name: requestBody.Name
          url: requestBody.URL
          method: requestBody.Method
      - text: Register endpoint {name} at {url} using auth config {auth}.
        slots:
          name: requestBody.Name
          url: requestBody.URL
          auth: requestBody.EndpointAuthConfigName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/external-endpoint-config/v1/endpoints/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate an external endpoint schema
      effect: read
      questions:
      - Can I check a request and response schema before saving an endpoint?
      - Is my external endpoint body schema valid?
      instructions:
      - text: Validate the endpoint request body schema {req}.
        slots:
          req: requestBody.RequestBody
      - text: Check the response schema {resp} for an external endpoint.
        slots:
          resp: requestBody.ResponseBody
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/external-endpoint-config/v1/endpoints/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an external endpoint configuration
      effect: read
      questions:
      - Where do I see the details of one endpoint configuration?
      - What URL and method does a configured endpoint use?
      instructions:
      - text: Get endpoint configuration {id}.
        slots:
          id: path.id
      - text: Show external endpoint {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/external-endpoint-config/v1/endpoints/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an external endpoint configuration
      effect: write
      questions:
      - How do I change the URL of a configured endpoint?
      - Can I swap the credentials an existing endpoint uses?
      instructions:
      - text: Update endpoint {id} to call {url}.
        slots:
          id: path.id
          url: requestBody.URL
      - text: Point endpoint configuration {id} at auth config {auth}.
        slots:
          id: path.id
          auth: requestBody.EndpointAuthConfigName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/external-endpoint-config/v1/endpoints/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an external endpoint configuration
      effect: destructive
      questions:
      - Can I remove an endpoint configuration we stopped using?
      - What happens to an external endpoint when I delete it?
      instructions:
      - text: Delete endpoint configuration {id}.
        slots:
          id: path.id
      - text: Remove external endpoint {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'