Skip to content

docs: correct Cloud PC recommendation report column names - #10103

Open
Ward1994 wants to merge 1 commit into
microsoftgraph:mainfrom
Ward1994:docs/fix-recommendation-plan-columns-65208230
Open

Ward1994 wants to merge 1 commit into
microsoftgraph:mainfrom
Ward1994:docs/fix-recommendation-plan-columns-65208230

Conversation

@Ward1994

@Ward1994 Ward1994 commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Important

Use the AI-powered workflow for Graph onboarding to author and self-review schema-related changes. See https://aka.ms/msgraphcdk for more information.

Required for API changes:

  • Link to API.md file: Not applicable. This PR corrects existing examples without changing API behavior.
  • Link to PR for public-facing schema changes (schema-Prod-beta/v1.0.csdl): Not applicable. No public-facing schema changes.

Add other supporting information, such as a description of the PR changes:

Summary

Correct the Example 2 selected columns and response schema in both beta and v1.0:

  • RecommendedPlanId -> RecommendedServicePlanId
  • RecommendedPlanName -> RecommendedServicePlanName

This is an example correction only; no API implementation or schema changes are included. Generated SDK snippets are intentionally unchanged and should be regenerated by the documentation pipeline from the updated HTTP examples.

Tracking: Bug 65208230.

Validation

  • Parsed the request and response JSON examples in both versions.
  • Checked that the selected columns match the supported query projection and response schema, and that response rows match the schema width.
  • git diff --check passes.

Publication follow-up

  • Confirm generated SDK snippets update after publication.

Important

The following guidance is for Microsoft employees only. Community contributors can ignore this message; our content team will manage the status.

After you've created your PR, expand this section for tips and additional instructions.
  • do not merge is the default PR status and is automatically added to all open PRs that don't have the ready to merge label.
  • Add the ready for content review label to start a review. Only PRs that have met the minimum requirements for content review and have this label are reviewed.
  • If your content reviewer requests changes, review the feedback and address accordingly as soon as possible to keep your pull request moving forward. After you address the feedback, remove the changes requested label, add the review feedback addressed label, and select the Re-request review icon next to the content reviewer's alias. If you can't add labels, add a comment with #feedback-addressed to the pull request.
  • After the content review is complete, your reviewer will add the content review complete label. When the updates in this PR are ready for external customers to use, replace the do not merge label with ready to merge and the PR will be merged within 24 working hours.
  • Pull requests that are inactive for more than 6 weeks will be automatically closed. Before that, you receive reminders at 2 weeks, 4 weeks, and 6 weeks. If you still need the PR, you can reopen or recreate the request.

For more information, see the Content review process summary.

Correct the Example 2 request and response column names in beta and v1.0. Leave generated SDK snippets to the documentation pipeline.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: a2cca2ee-8f7b-4017-b591-4c8d8a2bf8d0

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.

🔵 Needs a closer look

The examples are internally consistent, but acceptance and response names for the renamed projection columns remain unverified across beta and v1.0, requiring live API or service-owner confirmation.

No open issues 🎉

What changed in this PR

Corrects the Cloud PC recommendation report’s Example 2 column names in both beta and v1.0 documentation. This is an example-only correction; API behavior and schema are unchanged.

Changes:

  • Replaces RecommendedPlanId and RecommendedPlanName with RecommendedServicePlanId and RecommendedServicePlanName in request selections.
  • Updates the corresponding response schema column names to match.

Generated SDK snippets remain unchanged for pipeline regeneration; live API validation is still pending.

File Description
api-reference/​v1.0/​api/​cloudpcreport-retrievecloudpcrecommendationreports.md Corrects Example 2 request and response column names for v1.0.
api-reference/​beta/​api/​cloudpcreport-retrievecloudpcrecommendationreports.md Applies the same Example 2 corrections to beta.

Review effort: Balanced

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 6beee37:

✅ Validation status: passed

File Status Preview URL Details
api-reference/beta/api/cloudpcreport-retrievecloudpcrecommendationreports.md ✅Succeeded
api-reference/v1.0/api/cloudpcreport-retrievecloudpcrecommendationreports.md ✅Succeeded

For more details, please refer to the build report.

@Ward1994
Ward1994 marked this pull request as ready for review November 19, 2026 08:37
@Ward1994 Ward1994 added the ready for content review PR is ready for a content review - content development and tech review are complete. label Nov 19, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

Thank you for indicating that your pull request is ready for content review, @Ward1994. It has been added to the Content Review project and an available reviewer will be assigned in the next one (1) business day, depending on demand. If this PR relates to any schema changes, refer to the pull request description box for quick instructions to move this PR forward.

Check the content review workflow here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready for content review PR is ready for a content review - content development and tech review are complete.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants