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

API Evangelist conversational phrasing for Identity.Governance Agreements.agreement File Localization…

13 actions 13 updates phrasing extends openapi/azure-ad-agreements-agreementfilelocalization-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 13

$.info
$.paths['/agreements/{agreement-id}/files'].get
$.paths['/agreements/{agreement-id}/files'].post
$.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}'].get
$.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}'].delete
$.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}'].patch
$.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions'].get
$.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions'].post
$.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}'].get
$.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}'].delete
$.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}'].patch
$.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/$count'].get
$.paths['/agreements/{agreement-id}/files/$count'].get

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 Identity.Governance Agreements.agreement File Localization…
  version: 1.0.0
extends: openapi/azure-ad-agreements-agreementfilelocalization-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: 12
- target: $.paths['/agreements/{agreement-id}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List a terms of use agreement's localized files
      effect: read
      questions:
      - Which language-specific PDFs are attached to a terms of use agreement in Entra?
      - How do I see every localized file on an agreement, given the files property is being deprecated?
      instructions:
      - text: List the localized PDF files of agreement {agreement}.
        slots:
          agreement: path.agreement-id
      - text: Show all language files attached to terms of use agreement {agreement}.
        slots:
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a localized file to an agreement
      effect: write
      questions:
      - Can I add a new language version of the PDF to an existing terms of use agreement?
      - What do I send to attach another localized file to an agreement?
      instructions:
      - text: Add a new localized file to agreement {agreement}.
        slots:
          agreement: path.agreement-id
      - text: Attach a localized PDF with versions {versions} to agreement {agreement}.
        slots:
          versions: requestBody.versions
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one legacy localized file of an agreement
      effect: read
      questions:
      - How do I read a single language PDF from an agreement's deprecated files list?
      - What language and version details does one localized agreement file hold?
      instructions:
      - text: Get localized file {file} of agreement {agreement}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      - text: Show the details of language PDF {file} attached to terms of use agreement {agreement}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a localized file from an agreement
      effect: destructive
      questions:
      - Can I remove one language version of the PDF from a terms of use agreement?
      - Is there a way to delete a localized agreement file only if it hasn't changed since I read it?
      instructions:
      - text: Delete localized file {file} from agreement {agreement}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      - text: Remove language PDF {file} from agreement {agreement} if its ETag matches {etag}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a localized file on an agreement
      effect: write
      questions:
      - How do I change the versions recorded on one language PDF of an agreement?
      - Can I edit an existing localized agreement file instead of adding a new one?
      instructions:
      - text: Update localized file {file} on agreement {agreement}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      - text: Set the versions of language PDF {file} in agreement {agreement} to {versions}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
          versions: requestBody.versions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a localized agreement file
      effect: read
      questions:
      - What customized versions exist for one language file of a terms of use agreement?
      - How do I see the version history of a localized agreement PDF?
      instructions:
      - text: List the versions of localized file {file} on agreement {agreement}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      - text: Show every customized version of language file {file} in agreement {agreement}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a version to a localized agreement file
      effect: write
      questions:
      - Can I publish a new version of a localized terms of use file?
      - Is there an endpoint to add another version under an agreement's language file?
      instructions:
      - text: Add a new version to localized file {file} on agreement {agreement}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      - text: Create a version entry for language file {file} of terms of use agreement {agreement}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one version of a localized agreement file
      effect: read
      questions:
      - How do I read a specific version of a localized terms of use file?
      - Can I fetch a single customized agreement file version by id?
      instructions:
      - text: Get version {version} of localized file {file} on agreement {agreement}.
        slots:
          version: path.agreementFileVersion-id
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      - text: Show file version {version} under language file {file} of agreement {agreement}.
        slots:
          version: path.agreementFileVersion-id
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a version of a localized agreement file
      effect: destructive
      questions:
      - How do I remove an old version of a localized terms of use file?
      - Can I delete one version without removing the whole language file?
      instructions:
      - text: Delete version {version} of localized file {file} on agreement {agreement}.
        slots:
          version: path.agreementFileVersion-id
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      - text: Remove file version {version} from language file {file} of agreement {agreement}.
        slots:
          version: path.agreementFileVersion-id
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a version of a localized agreement file
      effect: write
      questions:
      - Can I modify an existing version of a localized terms of use file?
      - Is there a way to patch a specific agreement file version in place?
      instructions:
      - text: Update version {version} of localized file {file} on agreement {agreement}.
        slots:
          version: path.agreementFileVersion-id
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      - text: Patch file version {version} under language file {file} of agreement {agreement}.
        slots:
          version: path.agreementFileVersion-id
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count versions of a localized agreement file
      effect: read
      questions:
      - How many versions does one localized terms of use file have?
      - What's the version count for an agreement's language file?
      instructions:
      - text: Count the versions of localized file {file} on agreement {agreement}.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      - text: Tell me how many versions language file {file} of agreement {agreement} has.
        slots:
          file: path.agreementFileLocalization-id
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agreements/{agreement-id}/files/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an agreement's localized files
      effect: read
      questions:
      - How many languages is a terms of use agreement available in?
      - What's the number of localized files on an agreement?
      instructions:
      - text: Count the localized files on agreement {agreement}.
        slots:
          agreement: path.agreement-id
      - text: Tell me how many language files terms of use agreement {agreement} has.
        slots:
          agreement: path.agreement-id
      method: generated
      generated: '2026-10-01'