# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postman Environments API
  version: 1.0.0
extends: openapi/postman-environments-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: 10
- target: $.paths['/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments
      effect: read
      questions:
      - Which environments do I have?
      - Can I list only the environments in a particular workspace?
      instructions:
      - text: List all my environments.
      - text: List the environments in workspace {workspace}.
        slots:
          workspace: query.workspace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment
      effect: write
      questions:
      - How do I create a new environment with variables in a workspace?
      - Is there a size limit on the environment I create?
      instructions:
      - text: Create an environment in workspace {workspace}.
        slots:
          workspace: query.workspace
      - text: Create environment {environment} in workspace {workspace}.
        slots:
          environment: requestBody.environment
          workspace: query.workspace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment
      effect: read
      questions:
      - How do I see the variables stored in one environment?
      - Can I look up an environment by its ID?
      instructions:
      - text: Get environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Show the variables in environment {environmentId}.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all of an environment's data
      effect: write
      questions:
      - Can I overwrite an environment completely with new variables?
      - What happens to existing variables when I replace an environment?
      instructions:
      - text: Replace environment {environmentId} entirely with {environment}.
        slots:
          environmentId: path.environmentId
          environment: requestBody.environment
      - text: Overwrite all variables in environment {environmentId}.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment
      effect: destructive
      questions:
      - How do I delete an environment?
      - Can I remove an old environment I no longer use?
      instructions:
      - text: Delete environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Remove the environment {environmentId} permanently.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update specific environment variables
      effect: write
      questions:
      - Can I add or change just one variable in an environment without replacing it?
      - Is it possible to add and replace variables in the same patch call?
      instructions:
      - text: Rename environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Add a variable to environment {environmentId} without touching the others.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/forks'].get
  update:
    x-apievangelist-phrasing:
      intent: List an environment's forks
      effect: read
      questions:
      - Who has forked this environment?
      - Can I sort an environment's forks by creation date?
      instructions:
      - text: List the forks of environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Show forks of environment {environmentId} sorted by {sort}.
        slots:
          environmentId: path.environmentId
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/forks'].post
  update:
    x-apievangelist-phrasing:
      intent: Fork an environment
      effect: write
      questions:
      - How do I fork an environment into a workspace?
      - Do I need to name an environment fork?
      instructions:
      - text: Fork environment {environmentId} into workspace {workspaceId} as {forkName}.
        slots:
          environmentId: path.environmentId
          workspaceId: query.workspaceId
          forkName: requestBody.forkName
      - text: Create a fork named {forkName} of environment {environmentId} in {workspaceId}.
        slots:
          forkName: requestBody.forkName
          environmentId: path.environmentId
          workspaceId: query.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/merges'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge a forked environment into its parent
      effect: write
      questions:
      - How do I merge changes from a forked environment back into the original?
      - Can I delete the fork automatically after merging it?
      instructions:
      - text: Merge forked environment {source} into parent {environmentId}.
        slots:
          source: requestBody.source
          environmentId: path.environmentId
      - text: Merge fork {source} into environment {environmentId} and delete the fork ({deleteSource}).
        slots:
          source: requestBody.source
          environmentId: path.environmentId
          deleteSource: requestBody.deleteSource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentUid}/pulls'].post
  update:
    x-apievangelist-phrasing:
      intent: Pull parent changes into a forked environment
      effect: write
      questions:
      - My forked environment is out of date; can I pull the parent's changes into it?
      - How do I update an environment fork from its source?
      instructions:
      - text: Pull changes from parent environment {source} into fork {environmentUid}.
        slots:
          source: requestBody.source
          environmentUid: path.environmentUid
      - text: Update forked environment {environmentUid} from its source {source}.
        slots:
          environmentUid: path.environmentUid
          source: requestBody.source
      method: generated
      generated: '2026-09-26'