add x-ms-enum for orbital #17238

ArcturusZhang · 2022-01-05T07:16:24Z

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 langauge 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 apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- 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.
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.

openapi-workflow-bot · 2022-01-05T07:16:26Z

Hi, @ArcturusZhang 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-workflow-bot · 2022-01-05T07:16:27Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2022-01-05T07:16:28Z

Swagger Validation Report

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

There are no breaking changes.

Compared Swaggers (Based on Oad v0.9.1)
- current:preview/2021-04-04-preview/orbital.json compared with base:preview/2021-04-04-preview/orbital.json

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- orbital/resource-manager/readme.md tag:package-2021-04-04-preview
Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- orbital/resource-manager/readme.md tag:package-2021-04-04-preview

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/preview/2021-04-04-preview/orbital.json#L1539
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: common-types/resource-management/v3/types.json#L368
⚠️ 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/preview/2021-04-04-preview/orbital.json#L1097
⚠️ 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/preview/2021-04-04-preview/orbital.json#L1415

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

Validation passes for Avocado.

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

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

orbital/resource-manager/readme.md#package-2021-04-04-preview

️️✔️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-01-05T07:16:28Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go-track2 - armorbital - 0.2.0

+	Const `Enum6Communication` has been removed
+	Const `Enum6EarthObservation` has been removed
+	Function `*AvailableGroundStationsClient.ListByCapability` parameter(s) have been changed from `(Enum6, *AvailableGroundStationsListByCapabilityOptions)` to `(CapabilityType, *AvailableGroundStationsListByCapabilityOptions)`
+	Function `Enum6.ToPtr` has been removed
+	Function `PossibleEnum6Values` has been removed

❌azure-sdk-for-python-track2 - track2_azure-mgmt-orbital - Approved - 1.0.0b1

❌azure-sdk-for-js - track2_@azure/arm-orbital - Approved - 1.0.0-beta.3

+	Operation AvailableGroundStations.listByCapability has a new signature
+	Removed Enum KnownEnum6

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

⚠️Warning [Logs]Release - Generate from 6a7c020. 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] notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.3.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.3.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.3.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-orbital [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model ContactProfile has a new parameter event_hub_uri
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Operation ContactProfilesOperations.begin_create_or_update has a new signature

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

⚠️Warning [Logs]Release - Generate from 6a7c020. 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
cmderr	[generate.py] 2022-01-07 02:06:34 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-orbital"
cmderr	[generate.py] 2022-01-07 02:06:34 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2022-01-07 02:06:34 INFO autorest --version=3.6.6 --use=@autorest/java@4.0.44 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/orbital/azure-resourcemanager-orbital --java.namespace=com.azure.resourcemanager.orbital   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/orbital/resource-manager/readme.md
cmderr	[generate.py] 2022-01-07 02:07:01 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2022-01-07 02:07:01 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2022-01-07 02:07:01 INFO [POM][Skip] pom already has module azure-resourcemanager-orbital
cmderr	[generate.py] 2022-01-07 02:07:01 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2022-01-07 02:07:01 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2022-01-07 02:07:01 INFO [POM][Success] Write to root pom

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

cmderr	[Inst] 2022-01-07 02:08:41 DEBUG Got artifact_id: azure-resourcemanager-orbital
cmderr	[Inst] 2022-01-07 02:08:41 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2022-01-07 02:08:41 DEBUG Got artifact: azure-resourcemanager-orbital-1.0.0-beta.1.jar
cmderr	[Inst] 2022-01-07 02:08:41 DEBUG Match jar package: azure-resourcemanager-orbital-1.0.0-beta.1.jar
cmderr	[Inst] 2022-01-07 02:08:41 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/17238/azure-sdk-for-java/azure-resourcemanager-orbital/azure-resourcemanager-orbital-1.0.0-beta.1.jar\" -o azure-resourcemanager-orbital-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-orbital -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-orbital-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}

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

️✔️Succeeded [Logs]Release - Generate from 6a7c020. 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] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*AvailableGroundStationsClient.ListByCapability` parameter(s) have been changed from `(Enum6, *AvailableGroundStationsListByCapabilityOptions)` to `(CapabilityType, *AvailableGroundStationsListByCapabilityOptions)`
info	[Changelog] - Const `Enum6Communication` has been removed
info	[Changelog] - Const `Enum6EarthObservation` has been removed
info	[Changelog] - Function `Enum6.ToPtr` has been removed
info	[Changelog] - Function `PossibleEnum6Values` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `CapabilityTypeCommunication`
info	[Changelog] - New const `CapabilityTypeEarthObservation`
info	[Changelog] - New function `CapabilityType.ToPtr() *CapabilityType`
info	[Changelog] - New function `PossibleCapabilityTypeValues() []CapabilityType`
info	[Changelog] - New field `EventHubURI` in struct `ContactProfilesProperties`
info	[Changelog]
info	[Changelog] Total 5 breaking change(s), 5 additive change(s).

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

⚠️Warning [Logs]Release - Generate from 6a7c020. 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] deprecated @microsoft/rush@5.59.1: The 5.59.1 release has a task runner regression.
cmderr [automation_init.sh] deprecated @microsoft/rush-lib@5.59.1: The 5.59.1 release has a task runner regression.
cmderr [automation_init.sh] read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr [automation_init.sh] npm WARN deprecated @rushstack/rush-azure-storage-build-cache-plugin@5.59.1: The 5.59.1 release has a task runner regression.
cmderr [automation_init.sh] deprecated @rushstack/rush-amazon-s3-build-cache-plugin@5.59.1: The 5.59.1 release has a task runner regression.
cmderr [automation_init.sh] npm WARN deprecated @rushstack/rush-sdk@5.59.1: The 5.59.1 release has a task runner regression.
cmderr [automation_init.sh] uuid@3.4.0: 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] @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr [automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
cmderr [automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 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

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

azure-arm-orbital-1.0.0-beta.3.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Type Alias CapabilityType
info	[Changelog]   - Added Enum KnownCapabilityType
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Operation AvailableGroundStations.listByCapability has a new signature
info	[Changelog]   - Removed Enum KnownEnum6

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

⚠️Warning [Logs]Release - Generate from 6a7c020. 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
warn	No file changes detected after generation

️✔️orbital [View full logs]

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

add x-ms-enum for orbital

86d9cc4

openapi-assignment-bot bot assigned qiaozha Jan 5, 2022

openapi-pipeline-app bot added the CI-BreakingChange-Go-V2 label Jan 5, 2022

openapi-sdkautomation bot mentioned this pull request Jan 5, 2022

[AutoPR track2_azure-mgmt-orbital] add x-ms-enum for orbital AzureSDKAutomation/azure-sdk-for-python#8530

Closed

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

This was referenced Jan 5, 2022

[AutoPR azure-resourcemanager-orbital] add x-ms-enum for orbital AzureSDKAutomation/azure-sdk-for-java#11956

Closed

[AutoPR track2_@azure/arm-orbital] add x-ms-enum for orbital AzureSDKAutomation/azure-sdk-for-js#7010

Closed

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Jan 5, 2022

thisisdevanshu self-requested a review January 6, 2022 20:10

thisisdevanshu approved these changes Jan 6, 2022

View reviewed changes

ArcturusZhang added the Approved-SdkBreakingChange-Go-V2 label Jan 7, 2022

msyyc added the Approved-SdkBreakingChange-Python label Jan 7, 2022

dw511214992 added the Approved-SdkBreakingChange-JavaScript label Jan 7, 2022

ArcturusZhang merged commit 6a7c020 into Azure:main Jan 7, 2022

ArcturusZhang deleted the x-ms-enum-orbital branch January 7, 2022 01:59

LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022

add x-ms-enum for orbital (Azure#17238)

217c633

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add x-ms-enum for orbital #17238

add x-ms-enum for orbital #17238

ArcturusZhang commented Jan 5, 2022

openapi-workflow-bot bot commented Jan 5, 2022

openapi-workflow-bot bot commented Jan 5, 2022

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

edited

Loading

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

edited

Loading

Breaking Changes Tracking

add x-ms-enum for orbital #17238

add x-ms-enum for orbital #17238

Conversation

ArcturusZhang commented Jan 5, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jan 5, 2022

openapi-workflow-bot bot commented Jan 5, 2022

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

Swagger Validation Report

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

Swagger Generation Artifacts

Breaking Changes Tracking

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

edited

Loading

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

edited

Loading