Azure Orbital - swagger fix for api-version 2022-11-01

[stuti-1807]

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

1. 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
2. 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.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

• 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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

[openapi-pipeline-app]

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
orbital.json	2022-11-01(7b02f4f)	2022-11-01(main)

️️✔️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]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2022-11-01	package-2022-11-01(7b02f4f)	package-2022-11-01(main)

The following errors/warnings exist before current PR submission:

Rule	Message
❌ ResourceNameRestriction	The resource name parameter 'spacecraftName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L156
❌ ResourceNameRestriction	The resource name parameter 'spacecraftName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L379
❌ ResourceNameRestriction	The resource name parameter 'spacecraftName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L427
❌ ResourceNameRestriction	The resource name parameter 'contactName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L427
❌ ResourceNameRestriction	The resource name parameter 'spacecraftName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L596
❌ ResourceNameRestriction	The resource name parameter 'contactProfileName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L664
❌ GetOperation200	The get operation should only return 200. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L1049
⚠️ ListInOperationName	Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L1017
⚠️ LocationMustHaveXmsMutability	Property location must have 'x-ms-mutability':['read', 'create'] extension defined. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L1869

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

Validation passes for Avocado.

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

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView 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.

️️✔️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).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

[openapi-workflow-bot]

Hi, @stuti-1807 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. vscswagger@microsoft.com

[openapi-pipeline-app]

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account. 

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

Breaking Changes Tracking

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

• ⚠️Warning [Logs]Release - Generate from 8725e07. 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]
  cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.4
  cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.4>
  cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.4` to update!
  cmderr	[automation_generate.sh] npm notice

• ️✔️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]

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

• ️✔️Succeeded [Logs]Release - Generate from 8725e07. 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-resourcemanager-orbital-1.0.0-beta.3.jar
  • azure-resourcemanager-orbital-1.0.0-beta.3-sources.jar

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

• ️✔️Succeeded [Logs]Release - Generate from 8725e07. 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

• ️✔️sdk/resourcemanager/orbital/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 succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from 8725e07. 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
  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
  cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.

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

  info	[Changelog]
  error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

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

• ⚠️Warning [Logs]Release - Generate from 8725e07. 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]  WARN 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 succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from 8725e07. 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.DefaultTag [View full logs]  [Release SDK Changes]
  • Az.Orbital.0.1.0.nupkg

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

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/orbital/armorbital	https://apiview.dev/Assemblies/Review/a2c61815e0ea42799b97c5683d10b1b0
Java	azure-resourcemanager-orbital	There is no API change compared with the previous version
JavaScript	@azure/arm-orbital	There is no API change compared with the previous version