# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Zones API
  version: 1.0.0
extends: openapi/microsoft-azure-zones-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: 14
- target: $.paths['/parties/{partyId}/zones'].get
  update:
    x-apievangelist-phrasing:
      intent: List a party's farm management zones
      effect: read
      questions:
      - Which management zones belong to one party in my farm data?
      - Can I filter a party's zones by status, source or creation date?
      instructions:
      - text: List the zones under party {party}.
        slots:
          party: path.partyId
      - text: Show party {party}'s zones with status {statuses}, {page_size} per page.
        slots:
          party: path.partyId
          statuses: query.statuses
          page_size: query.maxPageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}/zones/{zoneId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one farm zone for a party
      effect: read
      questions:
      - How can I read the details of a single field zone that belongs to a party?
      - What properties are stored on a specific farm zone?
      instructions:
      - text: Get zone {zone} belonging to party {party}.
        slots:
          zone: path.zoneId
          party: path.partyId
      - text: Show me the farm zone record {zone} for grower party {party}.
        slots:
          zone: path.zoneId
          party: path.partyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}/zones/{zoneId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a party's farm zone
      effect: destructive
      questions:
      - Can I remove a single field zone from a party without a cascade job?
      - What happens when I delete one zone that belongs to a party?
      instructions:
      - text: Delete zone {zone} from party {party}.
        slots:
          zone: path.zoneId
          party: path.partyId
      - text: Remove the farm zone {zone} that party {party} owns.
        slots:
          zone: path.zoneId
          party: path.partyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}/zones/{zoneId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Create or update a party's farm zone
      effect: write
      questions:
      - How do I define a new management zone for a party's field?
      - Can I rename a farm zone or change its type and status?
      instructions:
      - text: Create zone {zone} for party {party} named {name} with type {type}.
        slots:
          zone: path.zoneId
          party: path.partyId
          name: requestBody.name
          type: requestBody.type
      - text: Set the status of farm zone {zone} under party {party} to {status}.
        slots:
          zone: path.zoneId
          party: path.partyId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones'].get
  update:
    x-apievangelist-phrasing:
      intent: List farm zones across all parties
      effect: read
      questions:
      - What management zones exist across every party in my agriculture data?
      - Can I list all farm zones by name or type without picking a party first?
      instructions:
      - text: List all farm zones across every party.
      - text: Show zones from all parties with names {names} and types {types}.
        slots:
          names: query.names
          types: query.types
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/cascade-delete/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a zone cascade delete job
      effect: read
      questions:
      - Has my zone cascade delete job finished?
      - Where do I see the status of a job that deletes a zone and its dependent data?
      instructions:
      - text: Get the status of zone cascade delete job {job}.
        slots:
          job: path.jobId
      - text: Check progress on cascade deletion job {job} for a farm zone.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/cascade-delete/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Start a cascade delete of a farm zone
      effect: destructive
      questions:
      - How do I delete a zone together with everything that depends on it?
      - Can I run zone deletion as a background job I can track?
      instructions:
      - text: Start cascade delete job {job} for zone {zone} of party {party}.
        slots:
          job: path.jobId
          zone: query.zoneId
          party: query.partyId
      - text: Cascade-delete farm zone {zone} owned by {party} under job id {job}.
        slots:
          zone: query.zoneId
          party: query.partyId
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DNS zone's properties
      effect: read
      questions:
      - What are the properties of my DNS zone, such as its name servers?
      - Can I read a DNS zone's settings without pulling all of its record sets?
      instructions:
      - text: Get DNS zone {zone_name}.
        slots:
          zone_name: path.zoneName
      - text: Show the properties of the {zone_name} DNS zone.
        slots:
          zone_name: path.zoneName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a DNS zone
      effect: write
      questions:
      - How do I host a new domain's DNS zone in Azure?
      - Can I avoid overwriting an existing DNS zone when creating one with the same name?
      instructions:
      - text: Create DNS zone {zone_name} in {location}.
        slots:
          zone_name: path.zoneName
          location: requestBody.location
      - text: Create DNS zone {zone_name} only if it does not already exist, using If-None-Match {if_none_match}.
        slots:
          zone_name: path.zoneName
          if_none_match: header.If-None-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS zone and all its records
      effect: destructive
      questions:
      - What happens to the records when I delete a DNS zone?
      - Can I make a DNS zone delete conditional on its current etag?
      instructions:
      - text: Delete DNS zone {zone_name} and all of its records.
        slots:
          zone_name: path.zoneName
      - text: Delete the {zone_name} DNS zone only if its etag matches {etag}.
        slots:
          zone_name: path.zoneName
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a DNS zone's tags
      effect: write
      questions:
      - How do I change the tags on an existing DNS zone?
      - Does patching a DNS zone touch the records inside it?
      instructions:
      - text: Set the tags on DNS zone {zone_name} to {tags}.
        slots:
          zone_name: path.zoneName
          tags: requestBody.tags
      - text: Patch DNS zone {zone_name} with new tags {tags} if its etag is {etag}.
        slots:
          zone_name: path.zoneName
          tags: requestBody.tags
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS zones in a resource group
      effect: read
      questions:
      - Which DNS zones live in one resource group?
      - Can I cap how many DNS zones come back for a resource group?
      instructions:
      - text: List the DNS zones in this resource group.
      - text: Show the first {top} DNS zones in the resource group.
        slots:
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS zones across a subscription
      effect: read
      questions:
      - What DNS zones do I have across all resource groups in my subscription?
      - Is there a subscription-wide listing of every hosted DNS zone?
      instructions:
      - text: List every DNS zone in my subscription.
      - text: Return up to {top} DNS zones from the whole subscription.
        slots:
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zone:search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search farm zones by geometry
      effect: read
      questions:
      - Which farm zones intersect a given field boundary or shape?
      - Can I search zones across all parties using a geometry?
      instructions:
      - text: Find zones that intersect geometry {geometry}.
        slots:
          geometry: requestBody.intersectsWithGeometry
      - text: Search party {party}'s zones overlapping {geometry}.
        slots:
          party: requestBody.partyId
          geometry: requestBody.intersectsWithGeometry
      method: generated
      generated: '2026-09-26'