Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management API Products API

6 actions 6 updates phrasing extends openapi/apigee-api-products-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}/apiproducts'].get

$.paths['/organizations/{organizationId}/apiproducts'].post

$.paths['/organizations/{organizationId}/apiproducts/{apiProductId}'].get

$.paths['/organizations/{organizationId}/apiproducts/{apiProductId}'].put

$.paths['/organizations/{organizationId}/apiproducts/{apiProductId}'].delete

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 Apigee API Management API Products API
  version: 1.0.0
extends: openapi/apigee-api-products-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}/apiproducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List API products in an organization
      effect: read
      questions:
      - What API products are defined in my Apigee organization?
      - Can I find API products that carry a particular custom attribute value?
      instructions:
      - text: List the API products in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Find API products in org {organizationId} where attribute {attributename} equals {attributevalue}.
        slots:
          organizationId: path.organizationId
          attributename: query.attributename
          attributevalue: query.attributevalue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/apiproducts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API product
      effect: write
      questions:
      - How do I bundle API proxies into a product that developers can subscribe to?
      - Can I set a quota and approval type when I create an API product?
      instructions:
      - text: Create API product {name} in organization {organizationId}.
        slots:
          name: requestBody.name
          organizationId: path.organizationId
      - text: Create API product {name} in org {organizationId} with proxies {proxies} and quota {quota} per {quotaTimeUnit}.
        slots:
          name: requestBody.name
          organizationId: path.organizationId
          proxies: requestBody.proxies
          quota: requestBody.quota
          quotaTimeUnit: requestBody.quotaTimeUnit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/apiproducts/{apiProductId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API product's configuration
      effect: read
      questions:
      - Which proxies, environments and quota does an API product include?
      - What approval type is set on one of my API products?
      instructions:
      - text: Get API product {apiProductId} in organization {organizationId}.
        slots:
          apiProductId: path.apiProductId
          organizationId: path.organizationId
      - text: Show the quota and proxies configured on API product {apiProductId} in org {organizationId}.
        slots:
          apiProductId: path.apiProductId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/apiproducts/{apiProductId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an API product
      effect: write
      questions:
      - Do I need to send the whole API product object to change one setting?
      - How do I add environments or scopes to an existing API product?
      instructions:
      - text: Update API product {apiProductId} in organization {organizationId}.
        slots:
          apiProductId: path.apiProductId
          organizationId: path.organizationId
      - text: Change the quota on existing API product {apiProductId} in org {organizationId} to {quota}.
        slots:
          apiProductId: path.apiProductId
          organizationId: path.organizationId
          quota: requestBody.quota
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/apiproducts/{apiProductId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API product
      effect: destructive
      questions:
      - What happens to apps using an API product when I delete it?
      - How do I remove an API product from my organization?
      instructions:
      - text: Delete API product {apiProductId} from organization {organizationId}.
        slots:
          apiProductId: path.apiProductId
          organizationId: path.organizationId
      - text: Remove the API product {apiProductId} in org {organizationId}.
        slots:
          apiProductId: path.apiProductId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'