Microsoft Azure Functions · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WebApps API Client Diagnostics API

23 actions 23 updates phrasing extends openapi/microsoft-azure-functions-diagnostics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure Functions's API. It is a proposal applied on top of the contract, not a document Microsoft Azure Functions publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 23 · first 16 shown; the file carries all of them

$.info

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute'].post

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute'].post

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for WebApps API Client Diagnostics API
  version: 1.0.0
extends: openapi/microsoft-azure-functions-diagnostics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 22
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detector responses for an App Service Environment
      effect: read
      questions:
      - What diagnostic detectors report on my App Service Environment?
      - How do I see all detector results for a hosting environment?
      instructions:
      - text: List detector responses for App Service Environment {name}.
        slots:
          name: path.name
      - text: Show all hosting environment diagnostics for {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one detector response for an App Service Environment
      effect: read
      questions:
      - Can I run a single detector against my App Service Environment for a specific time window?
      - What did one hosting environment detector find between two times?
      instructions:
      - text: Get detector {detectorName} for App Service Environment {name}.
        slots:
          detectorName: path.detectorName
          name: path.name
      - text: Get environment detector {detectorName} on {name} from {startTime} to {endTime}.
        slots:
          detectorName: path.detectorName
          name: path.name
          startTime: query.startTime
          endTime: query.endTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detector responses for a web app
      effect: read
      questions:
      - Which diagnostic detectors have results for my production web app?
      - How do I get an overview of all detector findings on a site?
      instructions:
      - text: List detector responses for site {siteName}.
        slots:
          siteName: path.siteName
      - text: Show all diagnostic detector results for my app {siteName}.
        slots:
          siteName: path.siteName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one detector response for a web app
      effect: read
      questions:
      - What did a particular detector find on my app during an outage window?
      - Can I set the time grain when pulling one detector's response for a site?
      instructions:
      - text: Get the response of detector {detectorName} for site {siteName}.
        slots:
          detectorName: path.detectorName
          siteName: path.siteName
      - text: Pull detector {detectorName} results for app {siteName} between {startTime} and {endTime}.
        slots:
          detectorName: path.detectorName
          siteName: path.siteName
          startTime: query.startTime
          endTime: query.endTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics'].get
  update:
    x-apievangelist-phrasing:
      intent: List diagnostic categories for a web app
      effect: read
      questions:
      - What diagnostic categories are available for troubleshooting my site?
      - Which categories of diagnostics can I explore on a production app?
      instructions:
      - text: List the diagnostic categories for site {siteName}.
        slots:
          siteName: path.siteName
      - text: Show troubleshooting categories available on app {siteName}.
        slots:
          siteName: path.siteName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a diagnostic category for a web app
      effect: read
      questions:
      - How do I look up one diagnostic category on my production site?
      - What does a single diagnostic category contain for an app?
      instructions:
      - text: Get diagnostic category {diagnosticCategory} for site {siteName}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      - text: Describe the {diagnosticCategory} category on app {siteName}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses'].get
  update:
    x-apievangelist-phrasing:
      intent: List analyses in a site diagnostic category
      effect: read
      questions:
      - Which analyses can I run within a diagnostic category for my app?
      - How do I see the available site analyses for a category?
      instructions:
      - text: List analyses in category {diagnosticCategory} for site {siteName}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      - text: Show every analysis offered under {diagnosticCategory} on my production app {siteName}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site analysis definition
      effect: read
      questions:
      - How do I look up the definition of one analysis for my site?
      - What does a named site analysis check without running it?
      instructions:
      - text: Get analysis {analysisName} in category {diagnosticCategory} for site {siteName}.
        slots:
          analysisName: path.analysisName
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      - text: Show the definition of site analysis {analysisName}.
        slots:
          analysisName: path.analysisName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a diagnostic analysis on a web app
      effect: read
      questions:
      - Can I execute a diagnostic analysis on my app over a specific time range?
      - How do I run an analysis to find why my production site was slow?
      instructions:
      - text: Execute analysis {analysisName} in {diagnosticCategory} on site {siteName}.
        slots:
          analysisName: path.analysisName
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      - text: Run analysis {analysisName} on app {siteName} from {startTime} to {endTime}.
        slots:
          analysisName: path.analysisName
          siteName: path.siteName
          startTime: query.startTime
          endTime: query.endTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detectors in a site diagnostic category
      effect: read
      questions:
      - Which detectors exist within a diagnostic category for my app?
      - How do I enumerate the detectors I can run in a category on a site?
      instructions:
      - text: List detectors in category {diagnosticCategory} for site {siteName}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      - text: Show the detectors available under {diagnosticCategory} on production app {siteName}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a detector definition in a site category
      effect: read
      questions:
      - How do I look up what a named detector in a diagnostic category does?
      - What is the definition of one detector for my site?
      instructions:
      - text: Get detector {detectorName} in category {diagnosticCategory} for site {siteName}.
        slots:
          detectorName: path.detectorName
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      - text: Describe detector {detectorName} under {diagnosticCategory}.
        slots:
          detectorName: path.detectorName
          diagnosticCategory: path.diagnosticCategory
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a detector on a web app
      effect: read
      questions:
      - Can I execute a detector in a diagnostic category against my app on demand?
      - How do I run a detector for a chosen time window and grain?
      instructions:
      - text: Execute detector {detectorName} in {diagnosticCategory} on site {siteName}.
        slots:
          detectorName: path.detectorName
          diagnosticCategory: path.diagnosticCategory
          siteName: path.siteName
      - text: Run detector {detectorName} on app {siteName} with time grain {timeGrain}.
        slots:
          detectorName: path.detectorName
          siteName: path.siteName
          timeGrain: query.timeGrain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detector responses for a deployment slot
      effect: read
      questions:
      - Which detectors have results for my staging deployment slot?
      - How do I get detector findings for a slot rather than the production app?
      instructions:
      - text: List detector responses for deployment slot {slot} of site {siteName}.
        slots:
          slot: path.slot
          siteName: path.siteName
      - text: Show all detector results on the {slot} slot.
        slots:
          slot: path.slot
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one detector response for a deployment slot
      effect: read
      questions:
      - What did a detector find on my staging slot during a given window?
      - Can I pull a single detector response scoped to a deployment slot?
      instructions:
      - text: Get detector {detectorName} response for slot {slot} of site {siteName}.
        slots:
          detectorName: path.detectorName
          slot: path.slot
          siteName: path.siteName
      - text: Pull detector {detectorName} on deployment slot {slot} from {startTime} to {endTime}.
        slots:
          detectorName: path.detectorName
          slot: path.slot
          startTime: query.startTime
          endTime: query.endTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics'].get
  update:
    x-apievangelist-phrasing:
      intent: List diagnostic categories for a deployment slot
      effect: read
      questions:
      - What diagnostic categories can I explore on a deployment slot?
      - Which troubleshooting categories apply to my staging slot?
      instructions:
      - text: List diagnostic categories for slot {slot} of site {siteName}.
        slots:
          slot: path.slot
          siteName: path.siteName
      - text: Show the troubleshooting categories on deployment slot {slot}.
        slots:
          slot: path.slot
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a diagnostic category for a deployment slot
      effect: read
      questions:
      - How do I look up one diagnostic category on a deployment slot?
      - What is in a single diagnostic category for my staging slot?
      instructions:
      - text: Get category {diagnosticCategory} for slot {slot} of site {siteName}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          slot: path.slot
          siteName: path.siteName
      - text: Describe the {diagnosticCategory} diagnostics on deployment slot {slot}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          slot: path.slot
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses'].get
  update:
    x-apievangelist-phrasing:
      intent: List analyses for a deployment slot category
      effect: read
      questions:
      - Which analyses are available in a diagnostic category on my staging slot?
      - How do I list slot-level site analyses?
      instructions:
      - text: List analyses in {diagnosticCategory} for slot {slot} of site {siteName}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          slot: path.slot
          siteName: path.siteName
      - text: Show analyses offered on deployment slot {slot}.
        slots:
          slot: path.slot
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site analysis for a deployment slot
      effect: read
      questions:
      - How do I look up an analysis definition scoped to a deployment slot?
      - What does a named analysis check on my staging slot?
      instructions:
      - text: Get analysis {analysisName} in {diagnosticCategory} for slot {slot} of site {siteName}.
        slots:
          analysisName: path.analysisName
          diagnosticCategory: path.diagnosticCategory
          slot: path.slot
          siteName: path.siteName
      - text: Show the slot {slot} definition of analysis {analysisName}.
        slots:
          slot: path.slot
          analysisName: path.analysisName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a diagnostic analysis on a deployment slot
      effect: read
      questions:
      - Can I run a diagnostic analysis against a staging slot instead of production?
      - How do I execute a slot analysis for a specific time window?
      instructions:
      - text: Execute analysis {analysisName} in {diagnosticCategory} on slot {slot} of site {siteName}.
        slots:
          analysisName: path.analysisName
          diagnosticCategory: path.diagnosticCategory
          slot: path.slot
          siteName: path.siteName
      - text: Run analysis {analysisName} on deployment slot {slot} from {startTime} to {endTime}.
        slots:
          analysisName: path.analysisName
          slot: path.slot
          startTime: query.startTime
          endTime: query.endTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detectors for a deployment slot category
      effect: read
      questions:
      - Which detectors can I run in a diagnostic category on a deployment slot?
      - How do I enumerate slot-level detectors?
      instructions:
      - text: List detectors in {diagnosticCategory} for slot {slot} of site {siteName}.
        slots:
          diagnosticCategory: path.diagnosticCategory
          slot: path.slot
          siteName: path.siteName
      - text: Show detectors available on deployment slot {slot}.
        slots:
          slot: path.slot
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a detector definition for a deployment slot
      effect: read
      questions:
      - How do I look up what a detector does on my staging slot?
      - What is the definition of a slot-scoped detector?
      instructions:
      - text: Get detector {detectorName} in {diagnosticCategory} for slot {slot} of site {siteName}.
        slots:
          detectorName: path.detectorName
          diagnosticCategory: path.diagnosticCategory
          slot: path.slot
          siteName: path.siteName
      - text: Describe the slot {slot} detector {detectorName}.
        slots:
          slot: path.slot
          detectorName: path.detectorName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a detector on a deployment slot
      effect: read
      questions:
      - Can I execute a detector against my staging slot on demand?
      - How do I run a slot detector with a custom time grain?
      instructions:
      - text: Execute detector {detectorName} in {diagnosticCategory} on slot {slot} of site {siteName}.
        slots:
          detectorName: path.detectorName
          diagnosticCategory: path.diagnosticCategory
          slot: path.slot
          siteName: path.siteName
      - text: Run detector {detectorName} on deployment slot {slot} with time grain {timeGrain}.
        slots:
          detectorName: path.detectorName
          slot: path.slot
          timeGrain: query.timeGrain
      method: generated
      generated: '2026-10-01'

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-functions-diagnostics-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.

GitHub Google LinkedIn

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