Swagger correctness action items #19484

MuraliKrishna4585 · 2022-06-16T18:03:51Z

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-pipeline-app · 2022-06-16T18:03:55Z

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.9.6)]	new version	base version
2021-06-01	2021-06-01(a5a718e)	2021-06-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 v1.13.0)	new version	base version
package-2021-06	package-2021-06(a5a718e)	package-2021-06(main)
package-composite-v2	package-composite-v2(a5a718e)	package-composite-v2(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` R4015 - NestedResourcesMustHaveListOperation	The nested resource 'DataWarehouseUserActivities' does not have list operation, please add it. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5703
`❌` R4015 - NestedResourcesMustHaveListOperation	The nested resource 'DataWarehouseUserActivities' does not have list operation, please add it. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5703
`❌` R4015 - NestedResourcesMustHaveListOperation	The nested resource 'SqlPoolConnectionPolicy' does not have list operation, please add it. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L6642
`❌` R4015 - NestedResourcesMustHaveListOperation	The nested resource 'SqlPoolConnectionPolicy' does not have list operation, please add it. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L6642
`❌` R4015 - NestedResourcesMustHaveListOperation	The nested resource 'SqlPoolVulnerabilityAssessmentRuleBaseline' does not have list operation, please add it. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L7007
`❌` R4015 - NestedResourcesMustHaveListOperation	The nested resource 'SqlPoolVulnerabilityAssessmentRuleBaseline' does not have list operation, please add it. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L7007
`❌` R4015 - NestedResourcesMustHaveListOperation	The nested resource 'DataMaskingPolicy' does not have list operation, please add it. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L7253
`❌` R4015 - NestedResourcesMustHaveListOperation	The nested resource 'DataMaskingPolicy' does not have list operation, please add it. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L7253
`❌` R4032 - MissingXmsErrorResponse	Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L191
`❌` R4032 - MissingXmsErrorResponse	Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L191
`❌` R4032 - MissingXmsErrorResponse	Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L550
`❌` R4032 - MissingXmsErrorResponse	Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L550
`❌` R4032 - MissingXmsErrorResponse	Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L615
`❌` R4032 - MissingXmsErrorResponse	Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L615
`❌` R4037 - MissingTypeObject	The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5432
`❌` R4037 - MissingTypeObject	The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5432
`❌` R4037 - MissingTypeObject	The schema 'GeoBackupPolicyProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5450
`❌` R4037 - MissingTypeObject	The schema 'GeoBackupPolicyProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5450
`❌` R4037 - MissingTypeObject	The schema 'GeoBackupPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5475
`❌` R4037 - MissingTypeObject	The schema 'GeoBackupPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5475
`❌` R4037 - MissingTypeObject	The schema 'GeoBackupPolicyListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5503
`❌` R4037 - MissingTypeObject	The schema 'GeoBackupPolicyListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5503
`❌` R4037 - MissingTypeObject	The schema 'TopQueries' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5515
`❌` R4037 - MissingTypeObject	The schema 'TopQueries' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5515
`❌` R4037 - MissingTypeObject	The schema 'QueryStatistic' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5598
`❌` R4037 - MissingTypeObject	The schema 'QueryStatistic' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5598
`❌` R4037 - MissingTypeObject	The schema 'QueryInterval' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5616
`❌` R4037 - MissingTypeObject	The schema 'QueryInterval' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5616
`❌` R4037 - MissingTypeObject	The schema 'QueryMetric' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5641
`❌` R4037 - MissingTypeObject	The schema 'QueryMetric' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L5641

️⚠️Avocado: 1 Warnings warning [Detail]

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

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

️❌ModelValidation: 14 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` INVALID_TYPE	Expected type but found type object Url: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L246:22 ExampleUrl: stable/2021-06-01/examples/DeleteSqlPool.json#L9:16
`❌` INVALID_TYPE	Expected type but found type object Url: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L246:22 ExampleUrl: stable/2021-06-01/examples/DeleteSqlPool.json#L9:16
`❌` INVALID_TYPE	Expected type but found type object Url: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L368:22 ExampleUrl: stable/2021-06-01/examples/PauseSqlPool.json#L9:16
`❌` INVALID_TYPE	Expected type but found type object Url: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L430:22 ExampleUrl: stable/2021-06-01/examples/ResumeSqlPool.json#L9:16
`❌` INVALID_FORMAT	Object didn't pass validation for format uuid: 999b999q-b888-4b44-bacd-2c222cc2222d Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1261:25 ExampleUrl: stable/2021-06-01/examples/GetWorkspace.json#L64:27
`❌` INVALID_FORMAT	Object didn't pass validation for format uuid: 999b999q-b888-4b44-bacd-2c222cc2222d Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1261:25 ExampleUrl: stable/2021-06-01/examples/UpdateWorkspace.json#L76:27
`❌` INVALID_FORMAT	Object didn't pass validation for format uuid: 999b999q-b888-4b44-bacd-2c222cc2222d Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1261:25 ExampleUrl: stable/2021-06-01/examples/UpdateWorkspace.json#L122:27
`❌` INVALID_FORMAT	Object didn't pass validation for format uuid: 999b999q-b888-4b44-bacd-2c222cc2222d Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1261:25 ExampleUrl: stable/2021-06-01/examples/CreateOrUpdateWorkspace.json#L124:27
`❌` INVALID_FORMAT	Object didn't pass validation for format uuid: 72f988bf-xxxx-41af-xxxx-2d7cd011db47 Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1024:21 ExampleUrl: stable/2021-06-01/examples/CreateOrUpdateWorkspace.json#L81:23
`❌` INVALID_FORMAT	Object didn't pass validation for format uuid: 72f988bf-xxxx-41af-xxxx-2d7cd011db47 Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1024:21 ExampleUrl: stable/2021-06-01/examples/CreateOrUpdateWorkspace.json#L161:23
`❌` INVALID_TYPE	Expected type but found type object Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L270:22 ExampleUrl: stable/2021-06-01/examples/DeleteWorkspace.json#L8:16
`❌` INVALID_TYPE	Expected type but found type object Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L270:22 ExampleUrl: stable/2021-06-01/examples/DeleteWorkspace.json#L8:16
`❌` INVALID_FORMAT	Object didn't pass validation for format uuid: 999b999q-b888-4b44-bacd-2c222cc2222d Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1261:25 ExampleUrl: stable/2021-06-01/examples/ListWorkspacesInSubscription.json#L27:31
`❌` INVALID_FORMAT	Object didn't pass validation for format uuid: 999b999q-b888-4b44-bacd-2c222cc2222d Url: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1261:25 ExampleUrl: stable/2021-06-01/examples/ListWorkspacesInSubscription.json#L50:31

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

Validation passes for SemanticValidation.

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

Validation passed for PoliCheck.

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

The following tags are being changed in this PR

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > PrivateEndpointConnectionForPrivateLinkHubBasic > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > KustoPoolProperties > properties > optimizedAutoscale)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > KustoPoolProperties > properties > languageExtensions)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > KustoPool > properties > systemData)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > AttachedDatabaseConfiguration > properties > systemData)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > AttachedDatabaseConfigurationProperties > properties > tableLevelSharingProperties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > Database > properties > systemData)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > DataConnection > properties > systemData)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > ClusterPrincipalAssignment > properties > systemData)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > DatabasePrincipalAssignment > properties > systemData)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v1", "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 > PrivateEndpointConnectionForPrivateLinkHubBasic > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-2021-06", "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 > PrivateEndpointConnectionForPrivateLinkHubBasic > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
💬	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"
💬	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"
💬	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"
💬	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"
💬	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Autorest completed in 20.81s. 0 files generated."
💬	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v1", "details":"Autorest completed in 12.1s. 0 files generated."
💬	"readme":"synapse/resource-manager/readme.md", "tag":"package-2021-06", "details":"Autorest completed in 11.78s. 0 files generated."

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.0.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.1.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.2.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.3.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.4.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.5.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.6.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.7.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.8.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.9.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.10.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.11.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.12.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.13.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.14.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.15.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.16.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Using directive.17.suppress which is deprecated and will be removed in the future."
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > OperationResource_Common > properties > status)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > OperationResource_Common > properties > error)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > PrivateLinkServiceProxyBase > properties > remotePrivateLinkServiceConnectionState)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > PrivateLinkServiceProxyBase > properties > remotePrivateEndpointConnection)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > PrivateEndpointConnectionForPrivateLinkHubBasic > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > PrivateEndpointConnectionBasic > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > PrivateEndpointConnectionProxyBase > properties > remotePrivateEndpoint)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "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 > PrivateEndpointConnectionForPrivateLinkHubProxyBase > properties > remotePrivateEndpoint)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v1", "details":"Using directive.0.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v1", "details":"Using directive.1.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v1", "details":"Using directive.2.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig	"readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v1", "details":"Using directive.3.suppress which is deprecated and will be removed in the future."

️️✔️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-workflow-bot · 2022-06-16T18:03:55Z

Hi, @MuraliKrishna4585 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-16T18:03:56Z

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 - armsynapse - 0.6.0

+	Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateDisabled` has been removed
+	Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateDisabling` has been removed
+	Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateEnabled` has been removed
+	Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateEnabling` has been removed
+	Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateUnknown` has been removed
+	Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredStateDisabled` has been removed
+	Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredStateEnabled` has been removed
+	Function `PossibleManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateValues` has been removed
+	Function `PossibleManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredStateValues` has been removed
+	Type of `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.ActualState` has been changed from `*ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualState` to `*ActualState`
+	Type of `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.DesiredState` has been changed from `*ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredState` to `*DesiredState`

️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-synapse - 2.1.0b5
❌azure-sdk-for-js - @azure/arm-synapse - 9.0.0-beta.1

+	Removed Enum KnownManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityActualState
+	Removed Enum KnownManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityDesiredState

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

❌Failed [Logs]Release - Generate from eca38ee. 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/synapse/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.
cmderr	[Autorest] Failure during batch task - {"tag":"$(tag)"} -- false.
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-js warning [Detail]

⚠️Warning [Logs]Release - Generate from eca38ee. 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] WARN deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
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]  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

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

azure-arm-synapse-9.0.0-beta.1.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettings
info	[Changelog]   - Added Interface DedicatedSQLminimalTlsSettingsListResult
info	[Changelog]   - Added Interface DedicatedSQLminimalTlsSettingsPatchInfo
info	[Changelog]   - Added Interface WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsGetOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsListNextOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsListOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsUpdateOptionalParams
info	[Changelog]   - Added Type Alias ActualState
info	[Changelog]   - Added Type Alias DedicatedSQLminimalTlsSettings
info	[Changelog]   - Added Type Alias DedicatedSQLMinimalTlsSettingsName
info	[Changelog]   - Added Type Alias DesiredState
info	[Changelog]   - Added Type Alias WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsGetResponse
info	[Changelog]   - Added Type Alias WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsListNextResponse
info	[Changelog]   - Added Type Alias WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsListResponse
info	[Changelog]   - Added Type Alias WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsUpdateResponse
info	[Changelog]   - Class SynapseManagementClient has a new parameter workspaceManagedSqlServerDedicatedSQLMinimalTlsSettings
info	[Changelog]   - Added Enum KnownDedicatedSQLMinimalTlsSettingsName
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Removed Enum KnownManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityActualState
info	[Changelog]   - Removed Enum KnownManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityDesiredState

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

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

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

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

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

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

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

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

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.DesiredState` has been changed from `*ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredState` to `*DesiredState`
info	[Changelog] - Type of `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.ActualState` has been changed from `*ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualState` to `*ActualState`
info	[Changelog] - Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateEnabled` has been removed
info	[Changelog] - Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredStateDisabled` has been removed
info	[Changelog] - Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredStateEnabled` has been removed
info	[Changelog] - Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateDisabling` has been removed
info	[Changelog] - Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateUnknown` has been removed
info	[Changelog] - Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateEnabling` has been removed
info	[Changelog] - Const `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateDisabled` has been removed
info	[Changelog] - Function `PossibleManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualStateValues` has been removed
info	[Changelog] - Function `PossibleManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredStateValues` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `ActualStateUnknown`
info	[Changelog] - New const `DesiredStateDisabled`
info	[Changelog] - New const `ActualStateDisabling`
info	[Changelog] - New const `DesiredStateEnabled`
info	[Changelog] - New const `ActualStateEnabling`
info	[Changelog] - New const `ActualStateEnabled`
info	[Changelog] - New const `ActualStateDisabled`
info	[Changelog] - New function `PossibleDesiredStateValues() []DesiredState`
info	[Changelog] - New function `PossibleActualStateValues() []ActualState`
info	[Changelog]
info	[Changelog] Total 10 breaking change(s), 9 additive change(s).

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

⚠️Warning [Logs]Release - Generate from eca38ee. 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

️✔️synapse [View full logs]

️❌ azure-powershell failed [Detail]

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

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

ghost · 2022-06-16T18:04:05Z

All CLA requirements met.

openapi-workflow-bot · 2022-06-16T18:06:40Z

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

Swagger correctness action items

32aea1c

MuraliKrishna4585 requested a review from wonner as a code owner June 16, 2022 18:03

openapi-assignment-bot bot assigned ruowan Jun 16, 2022

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

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

MuraliKrishna4585 and others added 3 commits June 20, 2022 11:53

Merge branch 'Azure:main' into v-mgundavar/SwaggerItems

831ca48

Merge branch 'Azure:main' into v-mgundavar/SwaggerItems

f69108f

Swagger Linting Changes

96c60e8

openapi-pipeline-app bot added CI-BreakingChange-Go CI-BreakingChange-JavaScript labels Jul 1, 2022

prettier-fix

a5a718e

ruowan added the Approved-ModelValidation label Jul 6, 2022

ruowan approved these changes Jul 6, 2022

View reviewed changes

ruowan merged commit eca38ee into Azure:main Jul 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swagger correctness action items #19484

Swagger correctness action items #19484

MuraliKrishna4585 commented Jun 16, 2022 •

edited

Loading

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

edited

Loading

openapi-workflow-bot bot commented Jun 16, 2022

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

edited

Loading

Breaking Changes Tracking

ghost commented Jun 16, 2022 •

edited by ghost

Loading

openapi-workflow-bot bot commented Jun 16, 2022

Swagger correctness action items #19484

Swagger correctness action items #19484

Conversation

MuraliKrishna4585 commented Jun 16, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

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

Swagger Validation Report

openapi-workflow-bot bot commented Jun 16, 2022

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

Swagger Generation Artifacts

Breaking Changes Tracking

ghost commented Jun 16, 2022 • edited by ghost Loading

openapi-workflow-bot bot commented Jun 16, 2022

MuraliKrishna4585 commented Jun 16, 2022 •

edited

Loading

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

edited

Loading

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

edited

Loading

ghost commented Jun 16, 2022 •

edited by ghost

Loading