# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Freeze CRUD API
  version: 1.0.0
extends: openapi/harness-freeze-crud-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['/ng/api/freeze'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deployment freeze window
      effect: write
      questions:
      - How do I set up a deployment freeze so nothing ships during a release blackout?
      - Can I create a freeze scoped to one project instead of the whole account?
      instructions:
      - text: Create a deployment freeze in account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Create a freeze window for project {projectIdentifier} in org {orgIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/freeze/{freezeIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment freeze
      effect: read
      questions:
      - How do I view the configuration of a specific freeze window?
      - What schedule and entities does a given freeze cover?
      instructions:
      - text: Get freeze {freezeIdentifier}.
        slots:
          freezeIdentifier: path.freezeIdentifier
      - text: Show freeze {freezeIdentifier} in project {projectIdentifier}.
        slots:
          freezeIdentifier: path.freezeIdentifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/freeze/{freezeIdentifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a deployment freeze
      effect: write
      questions:
      - Can I change the window or scope of an existing freeze?
      - How do I edit a freeze that is already defined?
      instructions:
      - text: Update freeze {freezeIdentifier} with the new window.
        slots:
          freezeIdentifier: path.freezeIdentifier
      - text: Edit freeze {freezeIdentifier} in org {orgIdentifier}.
        slots:
          freezeIdentifier: path.freezeIdentifier
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/freeze/{freezeIdentifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single deployment freeze
      effect: destructive
      questions:
      - How do I delete one freeze window?
      - Can I remove a freeze I no longer need by its identifier?
      instructions:
      - text: Delete freeze {freezeIdentifier}.
        slots:
          freezeIdentifier: path.freezeIdentifier
      - text: Remove the freeze {freezeIdentifier} from project {projectIdentifier}.
        slots:
          freezeIdentifier: path.freezeIdentifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/freeze/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete several deployment freezes at once
      effect: destructive
      questions:
      - Is there a bulk way to delete multiple freezes in one request?
      - Can I clean up many old freeze windows together?
      instructions:
      - text: Bulk delete the listed freezes in account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Delete several freezes at once in project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/freeze/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List deployment freezes
      effect: read
      questions:
      - Which deployment freezes are defined in my project?
      - Can I filter freezes by status or by a start and end time?
      - How do I search freeze windows by name?
      instructions:
      - text: List freezes in project {projectIdentifier} of org {orgIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
          orgIdentifier: query.orgIdentifier
      - text: List freezes with status {freezeStatus}.
        slots:
          freezeStatus: requestBody.freezeStatus
      - text: Find freezes matching {searchTerm} between {startTime} and {endTime}.
        slots:
          searchTerm: requestBody.searchTerm
          startTime: requestBody.startTime
          endTime: requestBody.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/freeze/getFrozenExecutionDetails'].get
  update:
    x-apievangelist-phrasing:
      intent: See which freezes blocked a pipeline execution
      effect: read
      questions:
      - My pipeline execution was frozen; which freeze stopped it?
      - Can I list the freezes that acted on one execution?
      instructions:
      - text: Show the freezes that blocked execution {planExecutionId} in project {projectIdentifier} of org {orgIdentifier}.
        slots:
          planExecutionId: query.planExecutionId
          projectIdentifier: query.projectIdentifier
          orgIdentifier: query.orgIdentifier
      - text: Explain why execution {planExecutionId} was frozen.
        slots:
          planExecutionId: query.planExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/freeze/getGlobalFreeze'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the global freeze YAML
      effect: read
      questions:
      - Is there a global freeze in effect, and what does its YAML look like?
      - How do I read the global freeze for an org or project?
      instructions:
      - text: Get the global freeze YAML for account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Show the global freeze for org {orgIdentifier}.
        slots:
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/freeze/manageGlobalFreeze'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up or manage the global freeze
      effect: write
      questions:
      - How do I turn on a global freeze that stops all deployments at once?
      - Can I manage the global freeze at the project level?
      instructions:
      - text: Configure the global freeze for account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Create a global freeze for project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/freeze/updateFreezeStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate freezes
      effect: write
      questions:
      - Can I switch a freeze between active and inactive without editing it?
      - What's the quickest way to pause a freeze window?
      instructions:
      - text: Set the freeze status to {status}.
        slots:
          status: query.status
      - text: Mark the selected freezes in project {projectIdentifier} as {status}.
        slots:
          projectIdentifier: query.projectIdentifier
          status: query.status
      method: generated
      generated: '2026-09-26'