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.
# 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 Discovery API
version: 1.0.0
extends: openapi/microsoft-azure-discovery-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: 4
- target: $.paths['/search/query'].post
update:
x-apievangelist-phrasing:
intent: Search the data catalog
effect: read
questions:
- How do I search my Purview data catalog for tables that mention customers?
- Can I filter and facet catalog search results, and page with offset and limit?
instructions:
- text: Search the data catalog for {keywords}.
slots:
keywords: requestBody.keywords
- text: Search catalog assets for {keywords} with filter {filter}, returning {limit} results sorted by {orderby}.
slots:
keywords: requestBody.keywords
filter: requestBody.filter
limit: requestBody.limit
orderby: requestBody.orderby
method: generated
generated: '2026-09-26'
- target: $.paths['/search/suggest'].post
update:
x-apievangelist-phrasing:
intent: Get search suggestions from the catalog
effect: read
questions:
- What matching assets does the catalog suggest as I type a partial name?
- Can I get suggested entities for a keyword before running a full search?
instructions:
- text: Suggest catalog assets for {keywords}.
slots:
keywords: requestBody.keywords
- text: Get up to {limit} entity suggestions for {keywords} matching filter {filter}.
slots:
limit: requestBody.limit
keywords: requestBody.keywords
filter: requestBody.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/browse'].post
update:
x-apievangelist-phrasing:
intent: Browse catalog entities by path or type
effect: read
questions:
- How do I browse catalog entities by their hierarchy path?
- Can I list all assets of one entity type without searching by keyword?
instructions:
- text: Browse catalog entities of type {type}.
slots:
type: requestBody.entityType
- text: Browse the catalog under path {path}, {limit} at a time from offset {offset}.
slots:
path: requestBody.path
limit: requestBody.limit
offset: requestBody.offset
method: generated
generated: '2026-09-26'
- target: $.paths['/search/autocomplete'].post
update:
x-apievangelist-phrasing:
intent: Autocomplete search keywords in the catalog
effect: read
questions:
- How can I complete a partially typed search term against the catalog?
- What keyword completions does the catalog offer for a prefix?
instructions:
- text: Autocomplete the search term {keywords}.
slots:
keywords: requestBody.keywords
- text: Return {limit} keyword completions for {keywords} under filter {filter}.
slots:
limit: requestBody.limit
keywords: requestBody.keywords
filter: requestBody.filter
method: generated
generated: '2026-09-26'
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.