Skip to content

Python: Fix Purview guide credential setup - #9553

Merged
Eduard van Valkenburg (eavanvalkenburg) merged 1 commit into
microsoft:mainfrom
ktz03:docs/purview-credential-setup-20261020
Oct 22, 2026
Merged

Eduard van Valkenburg (eavanvalkenburg) merged 1 commit into
microsoft:mainfrom
ktz03:docs/purview-credential-setup-20261020

Conversation

@ktz03

Copy link
Copy Markdown
Contributor

Motivation & Context

The Purview package guide illustrates PurviewPolicyMiddleware(settings=settings), but the constructor requires a credential as well. It also describes PurviewSettings as Pydantic settings although the current type is a TypedDict.

Description & Review Guide

  • What are the major changes? Pass DefaultAzureCredential() to the illustrated constructor and describe the settings type accurately. The existing ellipses remain application-specific placeholders.
  • What is the impact of these changes? The guide matches the existing API; runtime code is unchanged. Windows local construction controls used current source. No token acquisition, middleware/policy execution, HTTP request, cloud/model, package build, full suite, or full sample execution was performed.
  • What do you want reviewers to focus on? The required credential argument and the settings type match the implementation and existing README pattern.

Related Issue

N/A - trivial change: correct an existing documentation example to supply an already-required parameter and fix its settings-type description. No API or runtime change.

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: Documentation, local verification, and PR description.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after a language prefix such as Python: or .NET:) — a workflow keeps the label and title prefix in sync automatically.

Copilot AI balanced review requested due to automatic review settings October 20, 2026 05:07
@ktz03
LI (ktz03) deployed to github-app-auth October 20, 2026 05:07 — with GitHub Actions Active
@ktz03
LI (ktz03) deployed to github-app-auth October 20, 2026 05:07 — with GitHub Actions Active
@agent-framework-automation agent-framework-automation Bot added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python labels Oct 20, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Both documentation corrections match the existing implementation, with no unresolved findings.

No open issues 🎉

What changed in this PR

Corrects the Purview package guide to match the existing API without changing runtime code.

Changes:

  • Supplies DefaultAzureCredential() to the middleware constructor.
  • Describes PurviewSettings as a TypedDict.
File Description
python/​packages/​purview/​AGENTS.md Corrects credential setup and settings-type documentation.

Review effort: Balanced

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The guide now matches the existing Purview API: PurviewPolicyMiddleware receives the required credential, and PurviewSettings is accurately described as a TypedDict.

Merged via the queue into microsoft:main with commit a479349 Oct 22, 2026
37 of 38 checks passed

This branch was successfully deployed

1 active deployment
github-app-auth — 3724e5ff Deployed Oct 20, 2026 by ktz03 via team_check #7095
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants