Remove multiapi documentation #42749
Conversation
Co-authored-by: msyyc <[email protected]>
Co-authored-by: msyyc <[email protected]>
msyyc
requested review from
scbedd,
mccoyp,
weshaggard,
benbp and
ChenxiJiang333
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR removes outdated multiapi documentation and related helper scripts since multiapi functionality is no longer supported for new Azure Python SDKs. The cleanup helps prevent confusion by removing obsolete guidance.
Key changes:
- Removes 5 files containing multiapi documentation and example configurations
- Removes 2 helper scripts for multiapi configuration
- Updates 6 files to remove multiapi references and fix broken links
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
sdk/appconfiguration/azure-mgmt-appconfiguration/CHANGELOG.md |
Removes broken link to deleted multiapi documentation |
scripts/multiapi-configuration-helper/python-multiapi-configuration-helper.py |
Deletes helper script for multiapi configuration |
scripts/multiapi-configuration-helper/README.md |
Deletes documentation for multiapi configuration helper |
scripts/multi_api_readme_help.py |
Deletes script for generating multiapi readme suggestions |
eng/.docsettings.yml |
Removes reference to deleted multi_api readme file |
doc/dev/private_package/python_multiapi_configuration.md |
Deletes multiapi configuration guide |
doc/dev/private_package/get_private_package.md |
Updates multiapi reference to note it's no longer supported |
doc/dev/mgmt/swagger_conf.md |
Removes multiapi template section and updates documentation |
doc/dev/mgmt/swagger/multi_api/readme.python.md |
Deletes multiapi Python readme template |
doc/dev/mgmt/swagger/multi_api/readme.md |
Deletes multiapi readme template |
doc/dev/mgmt/multiapi.md |
Deletes main multiapi documentation |
doc/dev/mgmt/mgmt_release.md |
Removes multiapi-specific changelog generation notes |
doc/dev/mgmt/generation.md |
Removes --multiapi flag from autorest example |
| @@ -14,7 +14,7 @@ Make sure your target tag is defined in `readme.md` and **default tag is same wi | |||
|
|
|||
| If there is no `Python multi-api` in `readme.python.md`(i.e. [datadog](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/datadog/resource-manager/readme.python.md)), skip this step. | |||
|
|
|||
| If there is `Python multi-api` in `readme.python.md` (i.e. [network](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/network/resource-manager/readme.python.md#python-multi-api)), you need additional configuration: [Python Multiapi Configuration](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/private_package/python_multiapi_configuration.md) | |||
| If there is `Python multi-api` in `readme.python.md` (i.e. [network](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/network/resource-manager/readme.python.md#python-multi-api)), this is no longer supported. | |||
There was a problem hiding this comment.
@copilot The linked document no longer mentions multi-API at all, so this full sentence can be removed.
There was a problem hiding this comment.
@copilot The linked document no longer mentions multi-API at all, so this full sentence can be removed.
There was a problem hiding this comment.
Done! I've removed the entire sentence about multi-API since the linked document no longer mentions it. The section now flows directly from step 2 to step 3 without the outdated reference. (629266a)
There was a problem hiding this comment.
Done! I've removed the entire sentence about multi-API since the linked document no longer mentions it. The section now flows directly from step 2 to step 3 without the outdated reference. (455ef94)
| @@ -44,7 +44,7 @@ | |||
|
|
|||
| ### Other Changes | |||
|
|
|||
| - Changed to multiapi package(please refer to https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/multiapi.md for more info) | |||
…elog link to commit Co-authored-by: msyyc <[email protected]>
Co-authored-by: msyyc <[email protected]>
| @@ -12,9 +12,7 @@ Make sure your target tag is defined in `readme.md` and **default tag is same wi | |||
|
|
|||
| ## 2.Configure `readme.python.md` | |||
There was a problem hiding this comment.
Now that the section is empty, this heading can be removed and the subsequent steps can be renumbered accordingly
This PR removes outdated multiapi documentation and related files as requested in the issue. The multiapi functionality is no longer supported for new SDKs, so the documentation should be cleaned up to avoid confusion.
Changes Made
Removed Files:
doc/dev/mgmt/multiapi.md- Main multiapi documentation explaining concepts and rationaledoc/dev/private_package/python_multiapi_configuration.md- Configuration guide for multiapi packagesdoc/dev/mgmt/swagger/multi_api/directory - Example multiapi swagger configurationsscripts/multiapi-configuration-helper/directory - Helper scripts for multiapi configurationscripts/multi_api_readme_help.py- Script for generating multiapi readme suggestionsUpdated Files:
doc/dev/mgmt/generation.md- Removed--multiapiflag from autorest example commanddoc/dev/mgmt/swagger_conf.md- Removed "Multi API readmes" section and updated template referencesdoc/dev/mgmt/mgmt_release.md- Removed multiapi-specific changelog generation notesdoc/dev/private_package/get_private_package.md- Removed outdated multiapi reference sentencesdk/appconfiguration/azure-mgmt-appconfiguration/CHANGELOG.md- Updated broken link to point to archived documentation for record-keepingeng/.docsettings.yml- Removed reference to deleted multi_api readmeWhat Was Preserved
The cleanup removes 7 files/directories and updates 6 files to ensure no broken references remain while preserving functional configurations that are still in use.
Fixes #42748.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.