Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure ApiManagementClient API Version Set API

6 actions 6 updates phrasing extends openapi/microsoft-azure-apiversionset-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 6

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}'].head

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 ApiManagementClient API Version Set API
  version: 1.0.0
extends: openapi/microsoft-azure-apiversionset-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: 5
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets'].get
  update:
    x-apievangelist-phrasing:
      intent: List API version sets in an APIM workspace
      effect: read
      questions:
      - Which API version sets are defined in my API Management workspace?
      - Can I filter a workspace's version sets by display name?
      instructions:
      - text: List the API version sets in workspace {workspace} of API Management service {service}.
        slots:
          workspace: path.workspaceId
          service: path.serviceName
      - text: Show workspace version sets matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API version set in a workspace
      effect: read
      questions:
      - How is a given API version set configured, header, query or segment versioning?
      - What does one workspace API version set contain?
      instructions:
      - text: Get the details of version set {versionSet} in workspace {workspace}, service {service}.
        slots:
          versionSet: path.versionSetId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Show the versioning scheme used by version set {versionSet}.
        slots:
          versionSet: path.versionSetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a workspace API version set
      effect: write
      questions:
      - How do I create a version set to group versions of an API in a workspace?
      - Can I overwrite an entire API version set definition in one call?
      instructions:
      - text: Create API version set {versionSet} in workspace {workspace} on service {service}.
        slots:
          versionSet: path.versionSetId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Replace the whole definition of workspace API version set {versionSet}.
        slots:
          versionSet: path.versionSetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an existing workspace API version set
      effect: write
      questions:
      - Can I change just the display name of an existing API version set?
      - How do I partially update a version set that is already in use?
      instructions:
      - text: Patch selected fields on existing version set {versionSet} in workspace {workspace}, service {service}.
        slots:
          versionSet: path.versionSetId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Rename existing API version set {versionSet} without redefining it.
        slots:
          versionSet: path.versionSetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get the ETag of a workspace API version set
      effect: read
      questions:
      - How do I get a version set's current ETag before a conditional update?
      - Is there a lightweight check that an API version set exists?
      instructions:
      - text: Fetch only the entity tag of version set {versionSet} in workspace {workspace}, service {service}.
        slots:
          versionSet: path.versionSetId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Check the ETag of workspace version set {versionSet} with a HEAD request.
        slots:
          versionSet: path.versionSetId
      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-apiversionset-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.