Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Key Value Maps API

4 actions 4 updates phrasing extends openapi/apigee-key-value-maps-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 4

$.info
$.paths['/organizations/{organizationId}/environments/{environmentId}/keyvaluemaps'].get
$.paths['/organizations/{organizationId}/environments/{environmentId}/keyvaluemaps'].post
$.paths['/organizations/{organizationId}/environments/{environmentId}/keyvaluemaps/{keyValueMapId}'].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 Key Value Maps API
  version: 1.0.0
extends: openapi/apigee-key-value-maps-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: 3
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/keyvaluemaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List key value maps in an environment
      effect: read
      questions:
      - Which key value maps exist in an environment?
      - What runtime lookup maps can my policies read in this environment?
      instructions:
      - text: List key value maps in environment {environmentId} of organization {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Show every KVM in {environmentId} for org {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/keyvaluemaps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a key value map
      effect: write
      questions:
      - How do I create a store of values policies can read at runtime?
      - Can I make a key value map encrypted?
      instructions:
      - text: Create key value map {name} in environment {environmentId} of organization {organizationId}.
        slots:
          name: requestBody.name
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Add an encrypted KVM {name} to {environmentId} in org {organizationId} with encrypted set to {encrypted}.
        slots:
          name: requestBody.name
          environmentId: path.environmentId
          organizationId: path.organizationId
          encrypted: requestBody.encrypted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/keyvaluemaps/{keyValueMapId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a key value map
      effect: destructive
      questions:
      - How do I remove a key value map from an environment?
      - Is deleting a KVM permanent?
      instructions:
      - text: Delete key value map {keyValueMapId} from environment {environmentId} of organization {organizationId}.
        slots:
          keyValueMapId: path.keyValueMapId
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Remove KVM {keyValueMapId} in {environmentId}, org {organizationId}.
        slots:
          keyValueMapId: path.keyValueMapId
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'