Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Integrations SFDC Channels API

3 actions 3 updates phrasing extends openapi/apigee-sfdc-channels-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 3

$.info

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/sfdcInstances/{sfdcInstanceId}/sfdcChannels'].get

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/sfdcInstances/{sfdcInstanceId}/sfdcChannels'].post

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 Integrations SFDC Channels API
  version: 1.0.0
extends: openapi/apigee-sfdc-channels-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: 2
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/sfdcInstances/{sfdcInstanceId}/sfdcChannels'].get
  update:
    x-apievangelist-phrasing:
      intent: List Salesforce channels on an instance
      effect: read
      questions:
      - Which Salesforce channels are set up on an SFDC instance?
      - Can I page through channels for one Salesforce instance?
      instructions:
      - text: List SFDC channels for instance {sfdcInstanceId}, product {productId}, in project {projectId}, location {locationId}.
        slots:
          sfdcInstanceId: path.sfdcInstanceId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show up to {pageSize} Salesforce channels on instance {sfdcInstanceId} in {projectId}/{locationId}, product {productId}.
        slots:
          pageSize: query.pageSize
          sfdcInstanceId: path.sfdcInstanceId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/sfdcInstances/{sfdcInstanceId}/sfdcChannels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Salesforce channel
      effect: write
      questions:
      - How do I subscribe an integration to a Salesforce event topic?
      - Can I create an inactive Salesforce channel to enable later?
      instructions:
      - text: Create an SFDC channel on instance {sfdcInstanceId}, product {productId}, in project {projectId}, location {locationId}.
        slots:
          sfdcInstanceId: path.sfdcInstanceId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Add channel {displayName} for topic {channelTopic} on Salesforce instance {sfdcInstanceId} in {projectId}/{locationId}, product {productId}.
        slots:
          displayName: requestBody.displayName
          channelTopic: requestBody.channelTopic
          sfdcInstanceId: path.sfdcInstanceId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'