Fix swagger file with missed API and properties #19605

Yiyao-MS · 2022-06-27T08:53:46Z

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.

openapi-workflow-bot · 2022-06-27T08:53:49Z

Hi, @Yiyao-MS 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-06-27T08:53:50Z

Swagger Validation Report

️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.9.6)]	new version	base version
ServiceOperations.json	2021-12-01(9dc4c76)	2021-12-01(main)
mysql.json	2021-05-01(9dc4c76)	2021-05-01(main)

Rule	Message
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L175:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1390:5
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'location' in response that was not found in the old version. New: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L320:7 Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L275:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'subscriptionId' in response that was not found in the old version. New: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L320:7 Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L275:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'location' in response that was not found in the old version. New: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2347:7 Old: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2302:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'subscriptionId' in response that was not found in the old version. New: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2347:7 Old: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2302:7

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 4 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-flexibleserver-2021-05-01	package-flexibleserver-2021-05-01(9dc4c76)	package-flexibleserver-2021-05-01(main)
package-flexibleserver-2021-12-01-preview	package-flexibleserver-2021-12-01-preview(9dc4c76)	package-flexibleserver-2021-12-01-preview(main)

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailabilityWithoutLocation_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L180
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailabilityWithoutLocation_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1395
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Check name availability Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L181
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Check name availability Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1396

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4037 - MissingTypeObject	The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2701
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2308
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2358
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2406
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2460
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2468
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2503
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2517
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2687
⚠️ R1003 - ListInOperationName	Since operation 'ConfigurationsBatchUpdate' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1154
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'CheckVirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L84
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L132
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L225
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'updateconfigurations' in:'Configurations_BatchUpdate'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1154
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'CheckVirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1299
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1347
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1440
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L546
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2567
⚠️ R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2607
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Restart a server Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L383

️⚠️Avocado: 1 Warnings warning [Detail]

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

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

"https://github.com/Azure/azure-rest-api-specs/blob/9dc4c76286da9c102428e6257b86854ce30c3cf8/specification/mysql/resource-manager/readme.md#tag-package-flexibleserver-2021-05-01">mysql/resource-manager/readme.md#package-flexibleserver-2021-05-01
"https://github.com/Azure/azure-rest-api-specs/blob/9dc4c76286da9c102428e6257b86854ce30c3cf8/specification/mysql/resource-manager/readme.md#tag-package-flexibleserver-2021-12-01-preview">mysql/resource-manager/readme.md#package-flexibleserver-2021-12-01-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"mysql/resource-manager/readme.md", "tag":"package-flexibleserver-2021-05-01", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"
⚠️ UnkownSecurityScheme	"readme":"mysql/resource-manager/readme.md", "tag":"package-flexibleserver-2021-12-01-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

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

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

openapi-pipeline-app · 2022-06-27T08:53:51Z

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-go - armmysql - 1.0.1
️✔️azure-sdk-for-go - armmysqlflexibleservers - 1.1.0-beta.1
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-rdbms - 10.2.0b1

️❌ azure-sdk-for-net failed [Detail]

❌Failed [Logs]Release - Generate from 1ba198d. 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=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/mysql/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
cmderr	[Autorest] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip package processing as generation is failed

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

⚠️Warning [Logs]Release - Generate from 1ba198d. 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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️track2_azure-mgmt-rdbms [View full logs] [Release SDK Changes]
- azure-mgmt-rdbms-10.2.0b1.zip
- azure_mgmt_rdbms-10.2.0b1-py3-none-any.whl
```
info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group CheckNameAvailabilityWithoutLocationOperations
```

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

️✔️Succeeded [Logs]Release - Generate from 1ba198d. 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-mysqlflexibleserver [View full logs] [Release SDK Changes]

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

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

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

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

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

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `ResetAllToDefaultFalse`
info	[Changelog] - New const `ResetAllToDefaultTrue`
info	[Changelog] - New function `PossibleResetAllToDefaultValues() []ResetAllToDefault`
info	[Changelog] - New function `*BackupsClient.Put(context.Context, string, string, string, *BackupsClientPutOptions) (BackupsClientPutResponse, error)`
info	[Changelog] - New function `NewCheckNameAvailabilityWithoutLocationClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CheckNameAvailabilityWithoutLocationClient, error)`
info	[Changelog] - New function `*CheckNameAvailabilityWithoutLocationClient.Execute(context.Context, NameAvailabilityRequest, *CheckNameAvailabilityWithoutLocationClientExecuteOptions) (CheckNameAvailabilityWithoutLocationClientExecuteResponse, error)`
info	[Changelog] - New function `*LogFilesClient.NewListByServerPager(string, string, *LogFilesClientListByServerOptions) *runtime.Pager[LogFilesClientListByServerResponse]`
info	[Changelog] - New function `NewLogFilesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*LogFilesClient, error)`
info	[Changelog] - New struct `BackupsClientPutOptions`
info	[Changelog] - New struct `BackupsClientPutResponse`
info	[Changelog] - New struct `CheckNameAvailabilityWithoutLocationClient`
info	[Changelog] - New struct `CheckNameAvailabilityWithoutLocationClientExecuteOptions`
info	[Changelog] - New struct `CheckNameAvailabilityWithoutLocationClientExecuteResponse`
info	[Changelog] - New struct `LogFile`
info	[Changelog] - New struct `LogFileListResult`
info	[Changelog] - New struct `LogFileProperties`
info	[Changelog] - New struct `LogFilesClient`
info	[Changelog] - New struct `LogFilesClientListByServerOptions`
info	[Changelog] - New struct `LogFilesClientListByServerResponse`
info	[Changelog] - New field `Tags` in struct `ConfigurationsClientListByServerOptions`
info	[Changelog] - New field `Keyword` in struct `ConfigurationsClientListByServerOptions`
info	[Changelog] - New field `Page` in struct `ConfigurationsClientListByServerOptions`
info	[Changelog] - New field `PageSize` in struct `ConfigurationsClientListByServerOptions`
info	[Changelog] - New field `ResetAllToDefault` in struct `ConfigurationListForBatchUpdate`
info	[Changelog] - New field `Location` in struct `VirtualNetworkSubnetUsageResult`
info	[Changelog] - New field `SubscriptionID` in struct `VirtualNetworkSubnetUsageResult`
info	[Changelog] - New field `Version` in struct `ServerPropertiesForUpdate`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 34 additive change(s).

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

⚠️Warning [Logs]Release - Generate from 1ba198d. 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 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] deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
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
warn	No file changes detected after generation
warn	No package detected after generation

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

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

️✔️mysql [View full logs]

️❌ azure-powershell failed [Detail]

❌Failed [Logs]Release - Generate from 1ba198d. 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.mysql [View full logs] [Release SDK Changes]

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

openapi-workflow-bot · 2022-06-27T08:56:32Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

openapi-workflow-bot · 2022-06-27T08:56:38Z

Hi @Yiyao-MS, 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.

…USAGE

Yiyao-MS · 2022-06-28T03:33:49Z

Fixed Issues:
https://portal.azure-devex-tools.com/amekpis/completeness/detail?errorId=1E490B21-FC59-45EB-8092-A77AD775FB44
https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=6628B5BB-3683-48A2-BE7B-F6A51E51B298

openapi-workflow-bot · 2022-07-05T02:40:56Z

Hi @Yiyao-MS, 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.

DaeunYim · 2022-07-12T17:38:07Z

@Yiyao-MS Can you add this to the most recent preview version? That version is where we generate python SDK and use in CLI. We need backward compatibility in APIs

ArcturusZhang · 2022-07-14T05:33:34Z

Adding the approve-breaking-change label since the corresponding item has been approved: https://msazure.visualstudio.com/One/_workitems/edit/14960361

Added checkNameAvailability to fix Completeness issue

6f61100

openapi-assignment-bot bot assigned ArcturusZhang Jun 27, 2022

openapi-pipeline-app bot added the NewApiVersionRequired label Jun 27, 2022

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

openapi-workflow-bot bot added the FixS360 label Jun 28, 2022

Added location and subid in the response of CHECKVIRTUALNETWORKSUBNET…

d5da322

…USAGE

Yiyao-MS changed the title ~~Added checkNameAvailability to fix Completeness issue~~ Fix swagger file with missed API and properties Jun 28, 2022

fix validation

bb9bc43

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jun 29, 2022

rename the operationid

5f405aa

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Jun 29, 2022

fix the locationname in example json file

f7626ff

ArcturusZhang added the BreakingChangeReviewRequired label Jul 5, 2022

jorgecotillo added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 5, 2022

fix the issues in the preview version

9dc4c76

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jul 13, 2022

ArcturusZhang added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 14, 2022

ArcturusZhang approved these changes Jul 14, 2022

View reviewed changes

ArcturusZhang merged commit 1ba198d into Azure:main Jul 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix swagger file with missed API and properties #19605

Fix swagger file with missed API and properties #19605

Yiyao-MS commented Jun 27, 2022 •

edited

Loading

openapi-workflow-bot bot commented Jun 27, 2022

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

edited

Loading

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

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Jun 27, 2022

openapi-workflow-bot bot commented Jun 27, 2022

Yiyao-MS commented Jun 28, 2022

openapi-workflow-bot bot commented Jul 5, 2022

DaeunYim commented Jul 12, 2022

ArcturusZhang commented Jul 14, 2022

Fix swagger file with missed API and properties #19605

Fix swagger file with missed API and properties #19605

Conversation

Yiyao-MS commented Jun 27, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jun 27, 2022

openapi-pipeline-app bot commented Jun 27, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jun 27, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Jun 27, 2022

openapi-workflow-bot bot commented Jun 27, 2022

Yiyao-MS commented Jun 28, 2022

openapi-workflow-bot bot commented Jul 5, 2022

DaeunYim commented Jul 12, 2022

ArcturusZhang commented Jul 14, 2022

Yiyao-MS commented Jun 27, 2022 •

edited

Loading

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

edited

Loading

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

edited

Loading