Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Integrations SFDC Instances API

6 actions 6 updates phrasing extends openapi/apigee-sfdc-instances-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}/sfdcInstances'].get

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

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

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

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

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 Instances API
  version: 1.0.0
extends: openapi/apigee-sfdc-instances-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}/sfdcInstances'].get
  update:
    x-apievangelist-phrasing:
      intent: List Salesforce instances for integrations
      effect: read
      questions:
      - Which Salesforce orgs are connected to my integrations?
      - Can I page through the SFDC instances for a product?
      instructions:
      - text: List SFDC instances for product {productId} in project {projectId}, location {locationId}.
        slots:
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show up to {pageSize} Salesforce instances for product {productId} in {projectId}/{locationId}.
        slots:
          pageSize: query.pageSize
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/sfdcInstances'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a Salesforce instance
      effect: write
      questions:
      - How do I connect a Salesforce org to my integrations?
      - Can I tie a new Salesforce instance to an existing auth config?
      instructions:
      - text: Create an SFDC instance for Salesforce org {sfdcOrgId} under product {productId} in project {projectId}, location {locationId}.
        slots:
          sfdcOrgId: requestBody.sfdcOrgId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Connect Salesforce org {sfdcOrgId} using auth config {authConfigId} for product {productId} in {projectId}/{locationId}.
        slots:
          sfdcOrgId: requestBody.sfdcOrgId
          authConfigId: requestBody.authConfigId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/sfdcInstances/{sfdcInstanceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Salesforce instance configuration
      effect: read
      questions:
      - Which Salesforce org ID does an SFDC instance point to?
      - What auth config does a Salesforce instance use?
      instructions:
      - text: Get SFDC instance {sfdcInstanceId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          sfdcInstanceId: path.sfdcInstanceId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the Salesforce org and auth config of instance {sfdcInstanceId} in {projectId}/{locationId}, product {productId}.
        slots:
          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}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Salesforce instance configuration
      effect: destructive
      questions:
      - How do I disconnect a Salesforce org from integrations?
      - Is removing an SFDC instance permanent?
      instructions:
      - text: Delete SFDC instance {sfdcInstanceId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          sfdcInstanceId: path.sfdcInstanceId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Disconnect Salesforce instance {sfdcInstanceId} from {projectId}/{locationId}, product {productId}.
        slots:
          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}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Salesforce instance configuration
      effect: write
      questions:
      - Can I switch a Salesforce instance to a different auth config?
      - How do I rename an SFDC instance?
      instructions:
      - text: Update SFDC instance {sfdcInstanceId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          sfdcInstanceId: path.sfdcInstanceId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Set auth config {authConfigId} on Salesforce instance {sfdcInstanceId} in {projectId}/{locationId}, product {productId}.
        slots:
          authConfigId: requestBody.authConfigId
          sfdcInstanceId: path.sfdcInstanceId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'