ManagementPartner: added x-ms-enum for swagger linter #17961

Ochirkhuyag · 2022-02-23T11:44:45Z

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 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 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.

openapi-workflow-bot · 2022-02-23T11:44:48Z

Hi, @Ochirkhuyag 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 · 2022-02-23T11:44:48Z

Swagger Validation Report

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

There are no breaking changes.

Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2018-02-01/ManagementPartner.json compared with base:preview/2018-02-01/ManagementPartner.json

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.2 )
- managementpartner/resource-manager/readme.md tag:package-2018-02
Linted configuring files (Based on target branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.2 )
- managementpartner/resource-manager/readme.md tag:package-2018-02

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4011 - DeleteOperationResponses	The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L156
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L247
`❌` R4018 - OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.ManagementPartner/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L169
`❌` R4019 - GetCollectionResponseSchema	The response in the GET collection operation 'Partners_Get' does not match the response definition in the individual GET operation 'Partner_Get' . Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L206
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetPartnerDetails Location: Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json#L211

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

managementpartner/resource-manager/readme.md#package-2018-02

️️✔️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-workflow-bot · 2022-02-23T11:44:48Z

[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-02-23T11:44:49Z

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 - armmanagementpartner - 0.3.0

️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-managementpartner - 1.0.0
❌azure-sdk-for-go - preview/managementpartner/mgmt/2018-02-01/managementpartner - v61.6.0

+	Const `BadRequest` has been removed
+	Const `Conflict` has been removed
+	Const `NotFound` has been removed
+	Function `PossibleCodeValues` has been removed
+	Type of `ExtendedErrorInfo.Code` has been changed from `Code` to `*string`

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

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

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --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/managementpartner/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.ManagementPartner [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.ManagementPartner.1.1.1-preview.nupkg
- Microsoft.Azure.Management.ManagementPartner.1.1.1-preview.symbols.nupkg

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

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

️✔️track2_azure-mgmt-managementpartner [View full logs] [Release SDK Changes]
- azure_mgmt_managementpartner-1.0.0b1-py3-none-any.whl
- azure-mgmt-managementpartner-1.0.0b1.zip
```
info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model Error has a new parameter code
info	[Changelog]   - Model Error has a new parameter message
```

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

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

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

️✔️preview/managementpartner/mgmt/2018-02-01/managementpartner [View full logs] [Release SDK Changes]

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `ExtendedErrorInfo.Code` has been changed from `Code` to `*string`
info	[Changelog] - Const `BadRequest` has been removed
info	[Changelog] - Const `Conflict` has been removed
info	[Changelog] - Const `NotFound` has been removed
info	[Changelog] - Function `PossibleCodeValues` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `Message` in struct `Error`
info	[Changelog] - New field `Code` in struct `Error`
info	[Changelog]
info	[Changelog] Total 5 breaking change(s), 1 additive change(s).

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

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

️✔️armmanagementpartner [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Struct `Error` has been removed
info	[Changelog] - Struct `ExtendedErrorInfo` has been removed
info	[Changelog]
info	[Changelog] Total 4 breaking change(s), 0 additive change(s).

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

⚠️Warning [Logs]Release - Generate from eecc79c. 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 read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] deprecated 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] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh]  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-managementpartner [View full logs] [Release SDK Changes]
- azure-arm-managementpartner-1.0.0-beta.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 eecc79c. 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

️✔️managementpartner [View full logs]

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

Co-authored-by: Ochi <ochisamand@microsoft.com>

ManagementPartner: added x-ms-enum for swagger linter

39a31ca

openapi-assignment-bot bot assigned akning-ms Feb 23, 2022

openapi-workflow-bot bot added the FixS360 label Feb 23, 2022

openapi-pipeline-app bot added the CI-BreakingChange-Go-V2 label Feb 23, 2022

akning-ms approved these changes Feb 25, 2022

View reviewed changes

akning-ms merged commit eecc79c into Azure:main Feb 25, 2022

FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022

ManagementPartner: added x-ms-enum for swagger linter (Azure#17961)

cf87282

Co-authored-by: Ochi <ochisamand@microsoft.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ManagementPartner: added x-ms-enum for swagger linter #17961

ManagementPartner: added x-ms-enum for swagger linter #17961

Ochirkhuyag commented Feb 23, 2022

openapi-workflow-bot bot commented Feb 23, 2022

openapi-pipeline-app bot commented Feb 23, 2022 •

edited

Loading

openapi-workflow-bot bot commented Feb 23, 2022

openapi-pipeline-app bot commented Feb 23, 2022 •

edited

Loading

Breaking Changes Tracking

ManagementPartner: added x-ms-enum for swagger linter #17961

ManagementPartner: added x-ms-enum for swagger linter #17961

Conversation

Ochirkhuyag commented Feb 23, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Feb 23, 2022

openapi-pipeline-app bot commented Feb 23, 2022 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Feb 23, 2022

openapi-pipeline-app bot commented Feb 23, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Feb 23, 2022 •

edited

Loading

openapi-pipeline-app bot commented Feb 23, 2022 •

edited

Loading