Updating descriptions and examples #19536

thisisdevanshu · 2022-06-20T18:56:04Z

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

Changelog

Add a changelog entry for 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
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

…pi-specs into main

openapi-workflow-bot · 2022-06-20T18:56:08Z

Hi, @thisisdevanshu 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. [email protected]

openapi-pipeline-app · 2022-06-20T18:56:10Z

Swagger Validation Report

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

There are no breaking changes.

Compared Swaggers (Based on Oad v0.9.5)
- current:stable/2022-03-01/orbital.json compared with base:stable/2022-03-01/orbital.json

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- orbital/resource-manager/readme.md tag:package-2022-03-01
Linted configuring files (Based on target branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- orbital/resource-manager/readme.md tag:package-2022-03-01

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'contacts' with immediate parent 'Spacecraft', must have a list by immediate parent operation. Location: Microsoft.Orbital/stable/2022-03-01/orbital.json#L1798
⚠️ R3027 - TrackedResourceListByResourceGroup	The tracked resource, 'Spacecraft', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.Orbital/stable/2022-03-01/orbital.json#L1266
⚠️ R3027 - TrackedResourceListByResourceGroup	The tracked resource, 'ContactProfile', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.Orbital/stable/2022-03-01/orbital.json#L1666

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]

The following tags are being changed in this PR

orbital/resource-manager/readme.md#package-2022-03-01

The following errors/warnings are introduced by current PR:

|:speech_balloon: |"readme":"orbital/resource-manager/readme.md",
"tag":"package-2022-03-01",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"|
|:speech_balloon: |"readme":"orbital/resource-manager/readme.md",
"tag":"package-2022-03-01",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"|
|:speech_balloon: |"readme":"orbital/resource-manager/readme.md",
"tag":"package-2022-03-01",
"details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"|
|:speech_balloon: |"readme":"orbital/resource-manager/readme.md",
"tag":"package-2022-03-01",
"details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"|

The following errors/warnings exist before current PR submission:

Rule	Message
`❌`	"readme":"orbital/resource-manager/readme.md", "tag":"package-2022-03-01", "details":"Process() cancelled due to failure "
`❌`	"readme":"orbital/resource-manager/readme.md", "tag":"package-2022-03-01", "details":"!Error: Plugin checker reported failure."
`❌`	"readme":"orbital/resource-manager/readme.md", "tag":"package-2022-03-01", "details":"Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing."
⚠️ IgnoredPropertyNextToRef	"readme":"orbital/resource-manager/readme.md", "tag":"package-2022-03-01", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > Resource > properties > systemData)\n keys: [ \u001b[32m'type'\u001b[39m ]"
💬	"readme":"orbital/resource-manager/readme.md", "tag":"package-2022-03-01", "details":"AutoRest core version selected from configuration: ^3.2.0."

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

openapi-pipeline-app · 2022-06-20T18:56:11Z

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-go - armorbital - 1.0.1
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-orbital - 1.0.0

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from eb606ec. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️track2_azure-mgmt-orbital [View full logs] [Release SDK Changes]
- azure_mgmt_orbital-1.0.0b1-py3-none-any.whl
- azure-mgmt-orbital-1.0.0b1.zip
```
info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added model ContactsStatus
```

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

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

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-orbital [View full logs] [Release SDK Changes]
- pom.xml

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

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

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️armorbital [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️⚠️ azure-sdk-for-js warning [Detail]

⚠️Warning [Logs]Release - Generate from eb606ec. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
cmderr	[automation_init.sh] npm WARN deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] npm WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh]  deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh]  deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

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

azure-arm-orbital-1.1.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Type Alias ContactsStatus
info	[Changelog]   - Added Enum KnownContactsStatus
info	[Changelog]   - Added Enum KnownStatus
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from eb606ec. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh]  old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json

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

️❌ azure-powershell failed [Detail]

❌Failed [Logs]Release - Generate from eb606ec. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

❌Az.orbital [View full logs] [Release SDK Changes]

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

openapi-workflow-bot · 2022-06-20T19:00:05Z

Hi @thisisdevanshu, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

openapi-workflow-bot · 2022-06-21T02:44:14Z

Hi @thisisdevanshu, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

weidongxu-microsoft

There is no REST API change.

weidongxu-microsoft · 2022-06-22T01:23:43Z

specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json

-            "name": "Status",
-            "modelAsString": false
+            "name": "ContactsStatus",
+            "modelAsString": true


This is the only change that affect SDK.

Status -> ContactsStatus is agreed by owner of released SDKs, as it fixes the duplication from another "Status".

I am not aware of the change in "modelAsString". This should be the correct value, but we need to get approval from Go. @tadelesh

You should be able to delete the "directive" in readme.go.md
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/orbital/resource-manager/readme.go.md

Thanks @weidongxu-microsoft. Changing to modelAsString: true won't cause breaking in Go.

weidongxu-microsoft

Sign off from SDK

@thisisdevanshu
Please delete the "directive" in readme.go.md
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/orbital/resource-manager/readme.go.md

weidongxu-microsoft · 2022-06-22T06:28:48Z

@thisisdevanshu

Please ping us to merge, after your team reviewed and approved.

thisisdevanshu · 2022-06-22T06:35:32Z

@weidongxu-microsoft
Other changes are already reviewed and approved by the team. We can merge the PR.

Create to sync Azure/azure-rest-api-specs#19536 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/orbital?expand=1)

thisisdevanshu-ms and others added 6 commits January 6, 2022 13:29

updated polarization

64262d8

polarization updated

30f0090

Merge branch 'Azure:main' into main

fbb3baf

Merge branch 'main' of https://github.com/thisisdevanshu/azure-rest-a…

6bd3956

…pi-specs into main

updated descriptions

908f12d

revert 2021-04-04-preview changes

b8ab2cb

openapi-assignment-bot bot assigned raych1 Jun 20, 2022

revert 2021-04-04-preview changes 1

94e6a73

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Jun 20, 2022

thisisdevanshu changed the title ~~Updating Descriptioms~~ Updating Descriptions and examples Jun 20, 2022

thisisdevanshu changed the title ~~Updating Descriptions and examples~~ Updating descriptions and examples Jun 20, 2022

fix prettier, spellcheck, breaking change

37a04e7

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jun 21, 2022

openapi-pipeline-app bot removed the BreakingChangeReviewRequired label Jun 21, 2022

modelValidation fix

2704d22

thisisdevanshu requested a review from ms-henglu June 22, 2022 00:26

weidongxu-microsoft reviewed Jun 22, 2022

View reviewed changes

weidongxu-microsoft approved these changes Jun 22, 2022

View reviewed changes

delelte contactsStatus directive from readme.go.md

fc48db0

thisisdevanshu requested a review from ArcturusZhang as a code owner June 22, 2022 06:18

weidongxu-microsoft added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Jun 22, 2022

weidongxu-microsoft merged commit eb606ec into Azure:main Jun 22, 2022

azure-sdk mentioned this pull request Jun 22, 2022

[ReleasePR @azure/arm-orbital] Azure Orbital - swagger fix for api-version 2022-11-01 Azure/azure-sdk-for-js#21613

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Updating descriptions and examples #19536

Updating descriptions and examples #19536

Uh oh!

thisisdevanshu commented Jun 20, 2022

Uh oh!

openapi-workflow-bot bot commented Jun 20, 2022

Uh oh!

openapi-pipeline-app bot commented Jun 20, 2022 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Jun 20, 2022 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-workflow-bot bot commented Jun 20, 2022

Uh oh!

openapi-workflow-bot bot commented Jun 21, 2022

Uh oh!

weidongxu-microsoft left a comment

Uh oh!

weidongxu-microsoft Jun 22, 2022

Uh oh!

weidongxu-microsoft Jun 22, 2022

Uh oh!

tadelesh Jun 22, 2022

Uh oh!

weidongxu-microsoft left a comment •

edited

Loading

Uh oh!

weidongxu-microsoft commented Jun 22, 2022

Uh oh!

thisisdevanshu commented Jun 22, 2022

Uh oh!

Uh oh!

Updating descriptions and examples #19536

Updating descriptions and examples #19536

Uh oh!

Conversation

thisisdevanshu commented Jun 20, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Jun 20, 2022

Uh oh!

openapi-pipeline-app bot commented Jun 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Jun 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-workflow-bot bot commented Jun 20, 2022

Uh oh!

openapi-workflow-bot bot commented Jun 21, 2022

Uh oh!

weidongxu-microsoft left a comment

Choose a reason for hiding this comment

Uh oh!

weidongxu-microsoft Jun 22, 2022

Choose a reason for hiding this comment

Uh oh!

weidongxu-microsoft Jun 22, 2022

Choose a reason for hiding this comment

Uh oh!

tadelesh Jun 22, 2022

Choose a reason for hiding this comment

Uh oh!

weidongxu-microsoft left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weidongxu-microsoft commented Jun 22, 2022

Uh oh!

thisisdevanshu commented Jun 22, 2022

Uh oh!

Uh oh!

openapi-pipeline-app bot commented Jun 20, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jun 20, 2022 •

edited

Loading

weidongxu-microsoft left a comment •

edited

Loading