Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Parties API

8 actions 8 updates phrasing extends openapi/microsoft-azure-parties-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/parties'].get
$.paths['/parties/{partyId}'].get
$.paths['/parties/{partyId}'].delete
$.paths['/parties/{partyId}'].patch
$.paths['/parties/cascade-delete/{jobId}'].get
$.paths['/parties/cascade-delete/{jobId}'].put
$.paths['/parties:overlap'].post

OpenAPI Overlay

Raw ↑
# 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 Parties API
  version: 1.0.0
extends: openapi/microsoft-azure-parties-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: 7
- target: $.paths['/parties'].get
  update:
    x-apievangelist-phrasing:
      intent: List farm parties with filters
      effect: read
      questions:
      - How do I list all the parties (growers) in my Azure Data Manager for Agriculture instance?
      - Can I filter parties by status or by when they were created?
      - Which parties were modified in the last month?
      instructions:
      - text: List all parties.
      - text: List parties named {names}.
        slots:
          names: query.names
      - text: List parties with status {statuses} created after {minCreatedDateTime}.
        slots:
          statuses: query.statuses
          minCreatedDateTime: query.minCreatedDateTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a party's details
      effect: read
      questions:
      - What details are stored for a single party record?
      - Can I look up one party by its ID to check its status?
      instructions:
      - text: Show me party {partyId}.
        slots:
          partyId: path.partyId
      - text: Get the name and description of party {partyId}.
        slots:
          partyId: path.partyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a party record
      effect: destructive
      questions:
      - How do I remove a single party resource without a cascade job?
      - What happens when I delete a party directly?
      instructions:
      - text: Delete party {partyId}.
        slots:
          partyId: path.partyId
      - text: Remove the party record {partyId} now.
        slots:
          partyId: path.partyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Create or update a party
      effect: write
      questions:
      - How do I add a new grower as a party in the agriculture data manager?
      - Can I change a party's name or description after it exists?
      instructions:
      - text: Create party {partyId} named {name}.
        slots:
          partyId: path.partyId
          name: requestBody.name
      - text: Update the description of party {partyId} to {description}.
        slots:
          partyId: path.partyId
          description: requestBody.description
      - text: Set the status of party {partyId} to {status}.
        slots:
          partyId: path.partyId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/cascade-delete/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a party cascade-delete job
      effect: read
      questions:
      - Has the cascade delete job for my party finished yet?
      - Where do I see the progress of a party cascade deletion?
      instructions:
      - text: Check the status of cascade delete job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show details of party deletion job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/cascade-delete/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Delete a party and all its data
      effect: destructive
      questions:
      - How do I delete a party together with everything under it?
      - Can I run a background job to wipe a grower and all their farm data?
      instructions:
      - text: Start cascade delete job {jobId} for party {partyId}.
        slots:
          jobId: path.jobId
          partyId: query.partyId
      - text: Delete party {partyId} and all of its child resources.
        slots:
          partyId: query.partyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties:overlap'].post
  update:
    x-apievangelist-phrasing:
      intent: Find overlapping area between resources
      effect: read
      questions:
      - How do I find the overlapping area between two field boundaries?
      - Can I check whether two farm resources overlap geographically?
      instructions:
      - text: Compute the overlap area between {resources}.
        slots:
          resources: requestBody.resources
      - text: Tell me how much two of my field geometries overlap.
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-parties-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.