Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Integrations Auth Configs API

6 actions 6 updates phrasing extends openapi/apigee-auth-configs-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['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs'].get
$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs'].post
$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs/{authConfigId}'].get
$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs/{authConfigId}'].delete
$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs/{authConfigId}'].patch

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 Integrations Auth Configs API
  version: 1.0.0
extends: openapi/apigee-auth-configs-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['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration auth configs
      effect: read
      questions:
      - Which credentials have my integrations been set up to use?
      - Can I filter the auth configs for an integrations product?
      instructions:
      - text: List auth configs for product {productId} in project {projectId}, location {locationId}.
        slots:
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show auth configs matching {filter} for product {productId} in {projectId}/{locationId}.
        slots:
          filter: query.filter
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration auth config
      effect: write
      questions:
      - How do I store an OAuth token or API key for an integration to use?
      - Can I get notified before an auth config expires?
      instructions:
      - text: Create an auth config named {displayName} for product {productId} in project {projectId}, location {locationId}.
        slots:
          displayName: requestBody.displayName
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Add a {credentialType} auth config for product {productId} in {projectId}/{locationId}.
        slots:
          credentialType: requestBody.credentialType
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs/{authConfigId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration auth config
      effect: read
      questions:
      - What credential type and state does one auth config have?
      - When does a specific integration auth config expire?
      instructions:
      - text: Get auth config {authConfigId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          authConfigId: path.authConfigId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the credential type of auth config {authConfigId} in {projectId}/{locationId}, product {productId}.
        slots:
          authConfigId: path.authConfigId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs/{authConfigId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration auth config
      effect: destructive
      questions:
      - Can I delete an auth config that an active integration version still uses?
      - How do I remove stored integration credentials?
      instructions:
      - text: Delete auth config {authConfigId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          authConfigId: path.authConfigId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove the credentials in auth config {authConfigId} from {projectId}/{locationId}, product {productId}.
        slots:
          authConfigId: path.authConfigId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/authConfigs/{authConfigId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an integration auth config
      effect: write
      questions:
      - How do I rotate the credentials in an existing auth config?
      - Can I change only the visibility of an auth config?
      instructions:
      - text: Update auth config {authConfigId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          authConfigId: path.authConfigId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Set visibility {visibility} on auth config {authConfigId} in {projectId}/{locationId}, product {productId}, mask {updateMask}.
        slots:
          visibility: requestBody.visibility
          authConfigId: path.authConfigId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'