# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for dotCMS REST Environment API
  version: 1.0.0
extends: openapi/dotcms-environment-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/api/v1/environments/endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List all push publishing endpoints
      effect: read
      questions:
      - Which push publishing endpoints are configured across all environments?
      - What receiving servers can I push content to?
      instructions:
      - text: List every push publishing endpoint.
      - text: Show all configured receiver endpoints.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/environments/endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a push publishing endpoint
      effect: write
      questions:
      - How do I add a receiving server to a push publishing environment?
      - Can I set an authorization token when creating an endpoint?
      instructions:
      - text: Create endpoint {name} at {protocol}://{address}:{port} in environment {environmentId}.
        slots:
          name: requestBody.name
          protocol: requestBody.protocol
          address: requestBody.address
          port: requestBody.port
          environmentId: requestBody.environmentId
      - text: Add a new receiver {name} to environment {environmentId} at host {address} port {port} over {protocol}.
        slots:
          name: requestBody.name
          environmentId: requestBody.environmentId
          address: requestBody.address
          port: requestBody.port
          protocol: requestBody.protocol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/environments/endpoints/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a push publishing endpoint
      effect: write
      questions:
      - How do I change the address or port of an existing push endpoint?
      - Can I disable an endpoint without deleting it?
      instructions:
      - text: Update endpoint {id} to {name} at {protocol}://{address}:{port} in environment {environmentId}.
        slots:
          id: path.id
          name: requestBody.name
          protocol: requestBody.protocol
          address: requestBody.address
          port: requestBody.port
          environmentId: requestBody.environmentId
      - text: Set enabled to {enabled} on existing endpoint {id} named {name} in environment {environmentId}, host {address}:{port} via {protocol}.
        slots:
          enabled: requestBody.enabled
          id: path.id
          name: requestBody.name
          environmentId: requestBody.environmentId
          address: requestBody.address
          port: requestBody.port
          protocol: requestBody.protocol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/environments/endpoints/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a push publishing endpoint
      effect: destructive
      questions:
      - How do I remove a receiving server from push publishing?
      - Can I delete one endpoint and keep its environment?
      instructions:
      - text: Delete endpoint {id}.
        slots:
          id: path.id
      - text: Remove push receiver {id} from its environment.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/environments/endpoints/{endpointId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one push publishing endpoint
      effect: read
      questions:
      - How do I see the settings of a single push endpoint?
      - What address and protocol does a given endpoint use?
      instructions:
      - text: Get endpoint {endpointId}.
        slots:
          endpointId: path.endpointId
      - text: Show the configuration of receiver {endpointId}.
        slots:
          endpointId: path.endpointId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/environments/endpoints/environment/{environmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List endpoints in one environment
      effect: read
      questions:
      - Which endpoints belong to a specific push publishing environment?
      - How many receiving servers does an environment have?
      instructions:
      - text: List endpoints in environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Show receivers configured for environment {environmentId}.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/environment'].get
  update:
    x-apievangelist-phrasing:
      intent: List all push publishing environments
      effect: read
      questions:
      - What push publishing environments are set up?
      - Which environments can content be pushed to?
      instructions:
      - text: List all publishing environments.
      - text: Show every environment I could push to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/environment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a push publishing environment
      effect: write
      questions:
      - How do I create a new push publishing environment?
      - Can I restrict who is allowed to send to an environment when creating it?
      instructions:
      - text: Create environment {name} with push mode {pushMode}.
        slots:
          name: requestBody.name
          pushMode: requestBody.pushMode
      - text: Set up environment {name} using {pushMode} and allow {whoCanSend} to send.
        slots:
          name: requestBody.name
          pushMode: requestBody.pushMode
          whoCanSend: requestBody.whoCanSend
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/environment/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a push publishing environment
      effect: write
      questions:
      - How do I rename an environment or change its push mode?
      - Can I change who can send to an existing environment?
      instructions:
      - text: Update environment {id} to name {name} and push mode {pushMode}.
        slots:
          id: path.id
          name: requestBody.name
          pushMode: requestBody.pushMode
      - text: Change who can send to existing environment {id} to {whoCanSend}, keeping name {name} and mode {pushMode}.
        slots:
          id: path.id
          whoCanSend: requestBody.whoCanSend
          name: requestBody.name
          pushMode: requestBody.pushMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/environment/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a push publishing environment
      effect: destructive
      questions:
      - How do I delete a whole push publishing environment?
      - What happens to an environment's endpoints when I delete it?
      instructions:
      - text: Delete environment {id}.
        slots:
          id: path.id
      - text: Remove push publishing environment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/environment/loadenvironments/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Load environments for the push dialog (legacy)
      effect: read
      questions:
      - Which environments does the legacy push publish dialog offer me?
      - How does the old loadenvironments call return environments I can send to?
      instructions:
      - text: Load sendable environments with the legacy call for {params}.
        slots:
          params: path.params
      - text: Get the push dialog environment list using {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'