Google Dialogflow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dialogflow CX API (v3) - Conversational Agents Deployments…

3 actions 3 updates phrasing extends openapi/google-dialogflow-deployments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Google Dialogflow's API. It is a proposal applied on top of the contract, not a document Google Dialogflow publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments'].get

$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments/{deploymentsId}'].get

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 Dialogflow CX API (v3) - Conversational Agents Deployments…
  version: 1.0.0
extends: openapi/google-dialogflow-deployments-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['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployments to an environment
      effect: read
      questions:
      - What has been deployed to one of my agent's environments over time?
      - Can I page through an environment's deployment history?
      instructions:
      - text: List deployments for environment {environment} of agent {agent}, project {project}, location {location}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} deployments of environment {environment} per page.
        slots:
          page_size: query.pageSize
          environment: path.environmentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments/{deploymentsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment
      effect: read
      questions:
      - Did a specific deployment to my environment succeed?
      - Which flow versions were included in one deployment?
      instructions:
      - text: Get deployment {deployment} in environment {environment} of agent {agent}, project {project}, location {location}.
        slots:
          deployment: path.deploymentsId
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the state and flow versions of deployment {deployment}.
        slots:
          deployment: path.deploymentsId
      method: generated
      generated: '2026-10-01'