Updated SDK documentation and Updated Reservation API version to previous SDK release version. #12281

rahuls-microsoft · 2021-01-05T01:39:20Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- [ x] Other, please clarify - Updated documentation. Updated Reservation API version to previous SDK release version.
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- [x ] SDK of .NET (need service team to ensure code readiness)
- [x ] SDK of Python
- SDK of Java
- [x ] SDK of Js
- [x ] SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

[ x] I commit to follow the Breaking Change Policy of “no breaking changes
[ x] I have reviewed the documentation for the workflow.
[x ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

…pportTicketAction. 2. Removing state=enabledForPreview. 3. Updating Example.

…into master

…st-api-specs

…20-10-01-preview/reservations.json, which matches the previous SDK release. 2. Documentation changes.

openapi-workflow-bot · 2021-01-05T01:39:24Z

Hi, @rahuls-microsoft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-01-05T01:39:27Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

Compared Swaggers (Based on Oad v0.8.5)
- original: stable/2020-10-25/quota.json <---> new: stable/2020-10-25/quota.json

️⚠️LintDiff: 107 Warnings warning [Detail]

Only 10 items are listed, please refer to log for more details.

Linted configuring files (Based on source branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- reservations/resource-manager/readme.md tag:package-2020-10-25
Linted configuring files (Based on target branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- reservations/resource-manager/readme.md tag:package-2020-10-25

Rule	Message
⚠️ R1006 - PutInOperationName	'PUT' operation 'ReservationOrder_Purchase' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L234
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L758
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L779
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L788
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L954
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L989
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L1172
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L1192
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L1533
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Capacity/preview/2020-10-01-preview/reservations.json#L2050

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/reservations/resource-manager/readme.md tag: specification/reservations/resource-manager/readme.md#tag-package-2020-10-25

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-01-05T01:39:28Z

Swagger Generation Artifacts

️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from f1b3d4c. Schema Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6320 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/reservations/resource-manager/readme.md

️✔️reservations [View full logs] [Release Schema Changes]

cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
cmderr	[resource-manager]  WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager]  optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from f1b3d4c. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	python3 -m venv venv
command	pip install --upgrade setuptools wheel pip
command	pip install pathlib jinja2 msrestazure
command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/reservations/resource-manager/readme.md

️✔️azure-mgmt-reservations [View full logs] [Release SDK Changes] Breaking Change Detected

cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-reservations
cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-reservations
cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.reservations
cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.reservations
cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.reservations
cmderr	[changelogReport] INFO:__main__:Report written to sdk/reservations/azure-mgmt-reservations/code_reports/latest/report.json
cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-reservations on PyPI
cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '0.2.0', '0.2.1', '0.3.0', '0.3.1', '0.3.2', '0.4.0', '0.5.0', '0.6.0', '0.7.0', '0.8.0', '1.0.0b1']
cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
cmderr	[changelogReportLatest] INFO:__main__:Installing version 0.8.0 of azure-mgmt-reservations in a venv
cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.reservations
cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.reservations
cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.reservations
cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/reservations/azure-mgmt-reservations/code_reports/0.8.0/report.json
cmdout	[Changelog] Size of delta 24.072% size of original (original: 42676 chars, delta: 10273 chars)
cmdout	[Changelog] **Features**
cmdout	[Changelog]   - Added operation group ExchangeOperations
cmdout	[Changelog]   - Added operation group CalculateExchangeOperations
cmdout	[Changelog] **Breaking changes**
cmdout	[Changelog]   - Operation ReservationOperations.available_scopes has a new signature
cmdout	[Changelog]   - Removed operation group AutoQuotaIncreaseOperations
warn	Breaking change found in changelog

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from f1b3d4c. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️preview/reservations/mgmt/2020-10-25/reservations [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
```
️✔️preview/reservations/mgmt/2019-07-19-preview/reservations [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️preview/reservations/mgmt/2019-04-01/reservations [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️preview/reservations/mgmt/2018-06-01/reservations [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️reservations/mgmt/2017-11-01/reservations [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from f1b3d4c. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/reservations/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.Reservations [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.Reservations.1.14.0-preview.nupkg
- Microsoft.Azure.Management.Reservations.1.14.0-preview.snupkg

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from f1b3d4c. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/reservations/resource-manager/readme.md

️✔️@azure/arm-reservations [View full logs] [Release SDK Changes]

azure-arm-reservations-5.1.0.tgz

cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/azureReservationAPI.js → ./dist/arm-reservations.js...
cmderr	[npmPack] created ./dist/arm-reservations.js in 448ms

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

_{Posted by Swagger Pipeline | How to fix these errors?}

…ONE quota request, so changing quotas to quota.

…st-api-specs

specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/quota.json

rahuls-microsoft · 2021-01-05T19:07:26Z

Why the Go SDK build is failing and blocking all other SDK generation?
Please suggest.

weidongxu-microsoft · 2021-01-06T01:25:38Z

@rahuls-microsoft I think it complains that preview json preview/2020-10-01-preview/reservations.json should be in tag labeled with -preview.

@ArcturusZhang for insight on Go error. We seems not requiring above for all SDKs?

specification/reservations/resource-manager/readme.md

weidongxu-microsoft · 2021-01-11T16:50:21Z

@ArcturusZhang PR updated, approve if you are OK with it.

rahuls-microsoft · 2021-01-11T19:32:35Z

Please approve and merge.
Thanks.

specification/reservations/resource-manager/readme.md

This reverts commit 8f58d34.

rahuls-microsoft added 11 commits June 4, 2020 15:42

1.Breaking Change - Removing duplicate autoQuotaIncreaseState from su…

3a31345

…pportTicketAction. 2. Removing state=enabledForPreview. 3. Updating Example.

Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs

2d30c2d

Updating Provider name in example.

d6599d1

Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs …

4b1565d

…into master

Capacity RP Quota APIs for GA

15e533d

Adding preview version to stable dir as base files.

8f96e78

Files from preview version, which will be removed.

8beb75c

Updating to GA Version.

b034d7f

Merge branch 'master' of https://github.com/rahuls-microsoft/azure-re…

cd7674b

…st-api-specs

Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs

6311684

1. Updated reservation version tag to - Microsoft.Capacity/preview/20…

14c272b

…20-10-01-preview/reservations.json, which matches the previous SDK release. 2. Documentation changes.

rahuls-microsoft requested a review from lirenhe as a code owner January 5, 2021 01:39

openapi-assignment-bot bot assigned weidongxu-microsoft Jan 5, 2021

openapi-pipeline-app bot added the CI-BreakingChange-Python label Jan 5, 2021

rahuls-microsoft added 4 commits January 4, 2021 18:20

Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs

436af3a

Documentation updates for put and patch request, which includes only …

d77efa6

…ONE quota request, so changing quotas to quota.

Merge branch 'master' of https://github.com/rahuls-microsoft/azure-re…

265aa4e

…st-api-specs

Update documenation for put.

8fcb79f

pilara-ms reviewed Jan 5, 2021

View reviewed changes

specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/quota.json Outdated Show resolved Hide resolved

pilara-ms reviewed Jan 5, 2021

View reviewed changes

specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/quota.json Show resolved Hide resolved

Doc update.

add00fa

pilara-ms reviewed Jan 5, 2021

View reviewed changes

specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/quota.json Show resolved Hide resolved

ArcturusZhang requested changes Jan 7, 2021

View reviewed changes

specification/reservations/resource-manager/readme.md Show resolved Hide resolved

rahuls-microsoft added 5 commits January 10, 2021 19:26

Adding -preview tag for GO sdk.

53031a3

Updating Go settings for output folder to be -preview.

a7963c7

Adding preview subdir for GO package.

8ea3dc3

Adding preview subdir to Go sdk path.

69ffa31

Removing tag - tag: package-2020-10-25-preview

3cd5abd

weidongxu-microsoft approved these changes Jan 11, 2021

View reviewed changes

ArcturusZhang requested changes Jan 12, 2021

View reviewed changes

specification/reservations/resource-manager/readme.md Show resolved Hide resolved

introduce a new tag to keep the go sdk package unchanged

8f58d34

ArcturusZhang approved these changes Jan 13, 2021

View reviewed changes

Revert "introduce a new tag to keep the go sdk package unchanged"

ba279fb

This reverts commit 8f58d34.

weidongxu-microsoft merged commit f1b3d4c into Azure:master Jan 13, 2021

rahuls-microsoft mentioned this pull request Jan 14, 2021

Quota API GA version SDK updates. Azure/azure-sdk-for-net#17965

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated SDK documentation and Updated Reservation API version to previous SDK release version. #12281

Updated SDK documentation and Updated Reservation API version to previous SDK release version. #12281

rahuls-microsoft commented Jan 5, 2021

openapi-workflow-bot bot commented Jan 5, 2021

openapi-pipeline-app bot commented Jan 5, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 5, 2021 •

edited

Loading

rahuls-microsoft commented Jan 5, 2021

weidongxu-microsoft commented Jan 6, 2021

weidongxu-microsoft commented Jan 11, 2021 •

edited

Loading

rahuls-microsoft commented Jan 11, 2021

Updated SDK documentation and Updated Reservation API version to previous SDK release version. #12281

Updated SDK documentation and Updated Reservation API version to previous SDK release version. #12281

Conversation

rahuls-microsoft commented Jan 5, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jan 5, 2021

openapi-pipeline-app bot commented Jan 5, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jan 5, 2021 • edited Loading

Swagger Generation Artifacts

rahuls-microsoft commented Jan 5, 2021

weidongxu-microsoft commented Jan 6, 2021

weidongxu-microsoft commented Jan 11, 2021 • edited Loading

rahuls-microsoft commented Jan 11, 2021

openapi-pipeline-app bot commented Jan 5, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 5, 2021 •

edited

Loading

weidongxu-microsoft commented Jan 11, 2021 •

edited

Loading