Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Applications.home Realm Discovery Policy API

4 actions 4 updates phrasing extends openapi/azure-ad-applications-homerealmdiscoverypolicy-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/applications/{application-id}/homeRealmDiscoveryPolicies'].get

$.paths['/applications/{application-id}/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}'].get

$.paths['/applications/{application-id}/homeRealmDiscoveryPolicies/$count'].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 Applications.home Realm Discovery Policy API
  version: 1.0.0
extends: openapi/azure-ad-applications-homerealmdiscoverypolicy-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: 3
- target: $.paths['/applications/{application-id}/homeRealmDiscoveryPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's home realm discovery policies
      effect: read
      questions:
      - Which home realm discovery policies are attached to my app registration?
      - How do I see the HRD policies applied to an application?
      instructions:
      - text: List the home realm discovery policies on application {application-id}.
        slots:
          application-id: path.application-id
      - text: Show the first {top} HRD policies for app {application-id}.
        slots:
          top: query.$top
          application-id: path.application-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one home realm discovery policy on an app
      effect: read
      questions:
      - Can I read a single home realm discovery policy assigned to an application?
      - What does a specific HRD policy on my app contain?
      instructions:
      - text: Get home realm discovery policy {policy} on application {application-id}.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
          application-id: path.application-id
      - text: Open HRD policy {policy} attached to app {application-id}.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
          application-id: path.application-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/homeRealmDiscoveryPolicies/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an application's home realm discovery policies
      effect: read
      questions:
      - How many home realm discovery policies does an application have?
      - Is there a quick way to count HRD policies on one app without listing them?
      instructions:
      - text: Count the home realm discovery policies on application {application-id}.
        slots:
          application-id: path.application-id
      - text: Tell me how many HRD policies app {application-id} has matching {filter}.
        slots:
          application-id: path.application-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'