Skip to content

Redirect rest-api docs to Microsoft Graph API documentation#1919

Open
toliaqat wants to merge 3 commits intoOneDrive:livefrom
toliaqat:tl-deprecate-graph-docs
Open

Redirect rest-api docs to Microsoft Graph API documentation#1919
toliaqat wants to merge 3 commits intoOneDrive:livefrom
toliaqat:tl-deprecate-graph-docs

Conversation

@toliaqat
Copy link
Copy Markdown

@toliaqat toliaqat commented Apr 3, 2026

The OneDrive REST API documentation is now maintained as part of the Microsoft Graph API docs. This change retires the 168 local rest-api pages by replacing them with DocFX redirect_url front matter that sends users to the Graph API OneDrive resource documentation at https://learn.microsoft.com/en-us/graph/api/resources/onedrive.

Changes:

  • Replace all 168 docs/rest-api/*.md files with redirect front matter
  • Remove docs/rest-api/config/ build artifacts (3 JSON files)
  • Update docs/TOC.md to remove rest-api navigation entries
  • Update docs/index.md to link directly to Graph API docs
  • Update docs/breadcrumb/toc.yml to remove REST API breadcrumb
  • Update external references in file-handlers, file-pickers, sample-code, and templates to use Graph API URLs

The OneDrive REST API documentation is now maintained as part of the
Microsoft Graph API docs. This change retires the 168 local rest-api
pages by replacing them with DocFX redirect_url front matter that
sends users to the Graph API OneDrive resource documentation at
https://learn.microsoft.com/en-us/graph/api/resources/onedrive.

Changes:
- Replace all 168 docs/rest-api/*.md files with redirect front matter
- Remove docs/rest-api/config/ build artifacts (3 JSON files)
- Update docs/TOC.md to remove rest-api navigation entries
- Update docs/index.md to link directly to Graph API docs
- Update docs/breadcrumb/toc.yml to remove REST API breadcrumb
- Update external references in file-handlers, file-pickers,
  sample-code, and templates to use Graph API URLs

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit c65f789:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/controls/file-pickers/js-v72/open-file.md ⚠️Warning View (>= odsp-graph-online) Details
docs/controls/file-pickers/js-v72/save-file.md ⚠️Warning View (>= odsp-graph-online) Details
docs/file-handlers/index.md ⚠️Warning View (>= odsp-graph-online) Details
docs/index.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/activities_list.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_get_specialfolder.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_get.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_list.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_recent.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_sharedbyme.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_sharedwithme.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_checkin.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_checkout.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_copy.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_createlink.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_createuploadsession.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_delete.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_delta.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_get_content_format.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_get_content.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_get.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_invite.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_list_children.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_list_permissions.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_list_thumbnails.md ⚠️Warning View (>= odsp-graph-online) Details

This comment lists only the first 25 files in the pull request.

docs/controls/file-pickers/js-v72/open-file.md

  • Line 96, Column 86: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 126, Column 30: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 179, Column 94: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/driveitem-createlink' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 96, Column 86: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' will be broken in isolated environments. Replace with a relative link.
  • Line 126, Column 30: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' will be broken in isolated environments. Replace with a relative link.
  • Line 179, Column 94: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/driveitem-createlink' will be broken in isolated environments. Replace with a relative link.
  • Line 226, Column 3: [Suggestion: other-site-link-broken - See documentation] Link 'https://api.onedrive.com/v1.0/' points to a page that doesn't exist. Check the path or URL and update the link.

docs/controls/file-pickers/js-v72/save-file.md

  • Line 81, Column 162: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 104, Column 86: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 81, Column 162: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' will be broken in isolated environments. Replace with a relative link.
  • Line 104, Column 86: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' will be broken in isolated environments. Replace with a relative link.

docs/file-handlers/index.md

  • Line 48, Column 74: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/auth-register-app-v2' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 148, Column 32: [Warning: hard-coded-locale - See documentation] Link 'https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-authentication-scenarios' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 149, Column 93: [Warning: hard-coded-locale - See documentation] Link 'https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-protocols-oidc' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 48, Column 74: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/auth-register-app-v2' will be broken in isolated environments. Replace with a relative link.
  • Line 148, Column 32: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-authentication-scenarios' will be broken in isolated environments. Replace with a relative link.
  • Line 149, Column 93: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-protocols-oidc' will be broken in isolated environments. Replace with a relative link.

docs/index.md

  • Line 26, Column 10: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/onedrive' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 26, Column 10: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/onedrive' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 93: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/sharepoint/dev/spfx/viva/get-started/build-first-sharepoint-adaptive-card-extension' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 236: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/sharepoint/dev/spfx/extensions/get-started/building-simple-cmdset-with-dialog-api' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 372: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/sharepoint/dev/spfx/web-parts/overview-client-side-web-parts' will be broken in isolated environments. Replace with a relative link.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

toliaqat and others added 2 commits April 16, 2026 20:52
Restore the core front matter fields (author, ms.author, ms.date, title,
ms.localizationpriority) alongside the redirect_url in all 168
docs/rest-api/*.md files. The publishing system requires these metadata
fields to be preserved even for redirected pages.

Also adds a one-line description body to each page for context.

Normalizes 3 files that used the variant 'localization_priority' field
name to the standard 'ms.localizationpriority'.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Update 134 rest-api docs to redirect to their specific Microsoft Graph
API equivalents instead of the top-level OneDrive resource page. Each
target URL was verified to return HTTP 200.

- 134 files now redirect to specific Graph API resource/method pages
- 34 files remain on the top-level fallback (concepts, getting-started,
  and 3 API pages with no direct Graph equivalent)
- 2 files mapped to closest Graph alternatives:
  driveitem_post_content -> driveitem-put-content
  webhooknotification -> changenotification

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 6ee411d:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/controls/file-pickers/js-v72/open-file.md ⚠️Warning View (>= odsp-graph-online) Details
docs/controls/file-pickers/js-v72/save-file.md ⚠️Warning View (>= odsp-graph-online) Details
docs/file-handlers/index.md ⚠️Warning View (>= odsp-graph-online) Details
docs/index.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/activities_list.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_get_specialfolder.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_get.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_list.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_recent.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_sharedbyme.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/drive_sharedwithme.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_checkin.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_checkout.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_copy.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_createlink.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_createuploadsession.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_delete.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_delta.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_get_content_format.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_get_content.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_get.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_invite.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_list_children.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_list_permissions.md ⚠️Warning View (>= odsp-graph-online) Details
docs/rest-api/api/driveitem_list_thumbnails.md ⚠️Warning View (>= odsp-graph-online) Details

This comment lists only the first 25 files in the pull request.

docs/controls/file-pickers/js-v72/open-file.md

  • Line 96, Column 86: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 126, Column 30: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 179, Column 94: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/driveitem-createlink' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 96, Column 86: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' will be broken in isolated environments. Replace with a relative link.
  • Line 126, Column 30: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' will be broken in isolated environments. Replace with a relative link.
  • Line 179, Column 94: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/driveitem-createlink' will be broken in isolated environments. Replace with a relative link.
  • Line 226, Column 3: [Suggestion: other-site-link-broken - See documentation] Link 'https://api.onedrive.com/v1.0/' points to a page that doesn't exist. Check the path or URL and update the link.

docs/controls/file-pickers/js-v72/save-file.md

  • Line 81, Column 162: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 104, Column 86: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 81, Column 162: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' will be broken in isolated environments. Replace with a relative link.
  • Line 104, Column 86: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/driveitem' will be broken in isolated environments. Replace with a relative link.

docs/file-handlers/index.md

  • Line 48, Column 74: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/auth-register-app-v2' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 148, Column 32: [Warning: hard-coded-locale - See documentation] Link 'https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-authentication-scenarios' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 149, Column 93: [Warning: hard-coded-locale - See documentation] Link 'https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-protocols-oidc' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 48, Column 74: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/auth-register-app-v2' will be broken in isolated environments. Replace with a relative link.
  • Line 148, Column 32: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-authentication-scenarios' will be broken in isolated environments. Replace with a relative link.
  • Line 149, Column 93: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-protocols-oidc' will be broken in isolated environments. Replace with a relative link.

docs/index.md

  • Line 26, Column 10: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/graph/api/resources/onedrive' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 26, Column 10: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/graph/api/resources/onedrive' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 93: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/sharepoint/dev/spfx/viva/get-started/build-first-sharepoint-adaptive-card-extension' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 236: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/sharepoint/dev/spfx/extensions/get-started/building-simple-cmdset-with-dialog-api' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 372: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/sharepoint/dev/spfx/web-parts/overview-client-side-web-parts' will be broken in isolated environments. Replace with a relative link.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant