Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Target Servers API

6 actions 6 updates phrasing extends openapi/apigee-target-servers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Apigee's API. It is a proposal applied on top of the contract, not a document Apigee publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers'].get
$.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers'].post
$.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers/{targetServerId}'].get
$.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers/{targetServerId}'].put
$.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers/{targetServerId}'].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 Apigee API Management Target Servers API
  version: 1.0.0
extends: openapi/apigee-target-servers-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: 5
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers'].get
  update:
    x-apievangelist-phrasing:
      intent: List target servers in an environment
      effect: read
      questions:
      - Which backend target servers are defined in an environment?
      - What backend endpoints can proxies in this environment route to?
      instructions:
      - text: List target servers in environment {environmentId} of organization {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Show the backend target servers for {environmentId} in org {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a target server
      effect: write
      questions:
      - How do I define a backend host and port that proxies can reference by name?
      - Can I enable TLS on a new target server?
      instructions:
      - text: Create target server {name} pointing to {host}:{port} in environment {environmentId} of organization {organizationId}.
        slots:
          name: requestBody.name
          host: requestBody.host
          port: requestBody.port
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Add backend {name} at host {host} port {port} with protocol {protocol} to {environmentId} in org {organizationId}.
        slots:
          name: requestBody.name
          host: requestBody.host
          port: requestBody.port
          protocol: requestBody.protocol
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers/{targetServerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a target server
      effect: read
      questions:
      - What host and port is a target server configured with?
      - Is a given target server enabled?
      instructions:
      - text: Get target server {targetServerId} in environment {environmentId} of organization {organizationId}.
        slots:
          targetServerId: path.targetServerId
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Show the host, port and TLS settings of target server {targetServerId} in {environmentId}, org {organizationId}.
        slots:
          targetServerId: path.targetServerId
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers/{targetServerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a target server
      effect: write
      questions:
      - How do I point an existing target server at a new backend host?
      - Must I send the full target server object to update it?
      instructions:
      - text: Update target server {targetServerId} in {environmentId} of org {organizationId} to name {name}, host {host}, port {port}.
        slots:
          targetServerId: path.targetServerId
          environmentId: path.environmentId
          organizationId: path.organizationId
          name: requestBody.name
          host: requestBody.host
          port: requestBody.port
      - text: Repoint existing target server {targetServerId} to {host}:{port} as {name} in environment {environmentId}, organization {organizationId}.
        slots:
          targetServerId: path.targetServerId
          host: requestBody.host
          port: requestBody.port
          name: requestBody.name
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/targetservers/{targetServerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a target server
      effect: destructive
      questions:
      - How do I remove a backend target server from an environment?
      - Is deleting a target server permanent?
      instructions:
      - text: Delete target server {targetServerId} from environment {environmentId} of organization {organizationId}.
        slots:
          targetServerId: path.targetServerId
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Remove backend definition {targetServerId} in {environmentId}, org {organizationId}.
        slots:
          targetServerId: path.targetServerId
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'