Skip to content

MICROSOFT.SERVICEFABRICMESH(Atlas) Swagger Correctness Fix#19634

Merged
jordan13game merged 2 commits intoAzure:mainfrom
rubinxiao:swagger_atlas_correctness_fix
Jul 12, 2022
Merged

MICROSOFT.SERVICEFABRICMESH(Atlas) Swagger Correctness Fix#19634
jordan13game merged 2 commits intoAzure:mainfrom
rubinxiao:swagger_atlas_correctness_fix

Conversation

@o0rubinx0o
Copy link
Contributor

@o0rubinx0o o0rubinx0o commented Jun 29, 2022

Changelog

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

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. 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:

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
Copy link

openapi-pipeline-app bot commented Jun 29, 2022

Swagger Validation Report

️❌BreakingChange: 23 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.9.6)] new version base version
servicefabricmesh.json 2018-07-01(e8e84cb) 2018-07-01(main)
servicefabricmesh.json 2018-09-01(e8e84cb) 2018-09-01(main)
Rule Message
1011 - AddingResponseCode The new version adds a response code '202'.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L159:11
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'code' renamed or removed?
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1663:7
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1660:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'message' renamed or removed?
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1663:7
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1660:7
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1663:7
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1660:7
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L82:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L82:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L123:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L123:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L167:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L164:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L373:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L370:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L413:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L410:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L471:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L468:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L500:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L497:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L555:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L552:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L596:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L593:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L637:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L634:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L677:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L674:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L717:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L714:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L772:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L769:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L813:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L810:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L854:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L851:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L894:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L891:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L934:13
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L931:13
1034 - AddedRequiredProperty The new version has new required property 'error' that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1662:5
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1659:5
1041 - AddedPropertyInResponse The new version has a new property 'error' in response that was not found in the old version.
New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1663:7
Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1660:7
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) new version base version
package-2018-09-01-preview package-2018-09-01-preview(e8e84cb) package-2018-09-01-preview(main)
package-2018-07-01-preview package-2018-07-01-preview(e8e84cb) package-2018-07-01-preview(main)

The following errors/warnings are introduced by current PR:

Rule Message
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Application_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L129


The following errors/warnings exist before current PR submission:

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

Rule Message
R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1381
R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1860
R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}/list_value'
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L497
R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L201
R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L244
R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L284
R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L330
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1388
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1421
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1450
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1827
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1948
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L2279
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L2614
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L2761
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L3044
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L3048
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L3052
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L3324
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L3349
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L3421
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L3559
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L3679
R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L3945
R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ServiceFabricMesh/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L478
R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ServiceFabricMesh/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L37
R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L946
R4037 - MissingTypeObject The schema 'ManagedProxyResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L992
R4037 - MissingTypeObject The schema 'TrackedResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1023
R4037 - MissingTypeObject The schema 'ProvisionedResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1056
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌ModelValidation: 8 Errors, 0 Warnings failed [Detail]
Rule Message
ENUM_CASE_MISMATCH Enum does not match case for: linux
Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1875:19
ExampleUrl: preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json#L9:39
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L479:14
INVALID_TYPE Expected type integer but found type string
Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1948:23
ExampleUrl: preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json#L9:35
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
Url: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L38:14
READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST ReadOnly property "name" cannot be sent in the request
Url: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L1953:17
ExampleUrl: examples/secrets/values/create.json#L10:39
ENUM_CASE_MISMATCH Enum does not match case for: linux
Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1875:19
ExampleUrl: preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json#L9:39
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L479:14
INVALID_TYPE Expected type integer but found type string
Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1948:23
ExampleUrl: preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json#L9:35
️️✔️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 errors/warnings are introduced by current PR:

|:speech_balloon: |"readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-09-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"|
|:speech_balloon: |"readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-09-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"|
|:speech_balloon: |"readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-09-01-preview",
"details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"|
|:speech_balloon: |"readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-09-01-preview",
"details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"|
|:speech_balloon: |"readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-09-01-preview",
"details":"Autorest completed in 10.58s. 0 files generated."|
|:speech_balloon: |"readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-07-01-preview",
"details":"Autorest completed in 3.7s. 0 files generated."|


The following errors/warnings exist before current PR submission:

Rule Message
⚠️ DeprecatedConfig "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-09-01-preview",
"details":"Using directive.0.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-09-01-preview",
"details":"Using directive.1.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-09-01-preview",
"details":"Using directive.2.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-07-01-preview",
"details":"Using directive.0.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-07-01-preview",
"details":"Using directive.1.suppress which is deprecated and will be removed in the future."
⚠️ DeprecatedConfig "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-07-01-preview",
"details":"Using directive.2.suppress which is deprecated and will be removed in the future."
💬 "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-09-01-preview",
"details":"AutoRest core version selected from configuration: ^3.2.0."
💬 "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-07-01-preview",
"details":"AutoRest core version selected from configuration: ^3.2.0."
💬 "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-07-01-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"
💬 "readme":"servicefabricmesh/resource-manager/readme.md",
"tag":"package-2018-07-01-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"
️️✔️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
Copy link

openapi-pipeline-app bot commented Jun 29, 2022

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 - armservicefabricmesh - 0.5.1
️❌ azure-sdk-for-net failed [Detail]
  • Failed [Logs]Release - Generate from 432872f. 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/servicefabricmesh/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] FATAL: System.InvalidOperationException: Values specified by 'enum' mismatch those specified by 'x-ms-enum' (name: 'SecretKind'): 'inlinedValue' vs 'InlinedValue'
    cmderr	[Autorest]    at AutoRest.Modeler.ObjectBuilder.BuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/ObjectBuilder.cs:line 132
    cmderr	[Autorest]    at AutoRest.Modeler.SchemaBuilder.ParentBuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/SchemaBuilder.cs:line 217
    cmderr	[Autorest]    at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/SchemaBuilder.cs:line 48
    cmderr	[Autorest]    at AutoRest.Modeler.SwaggerModeler.BuildCompositeTypes() in /opt/vsts/work/1/s/src/SwaggerModeler.cs:line 348
    cmderr	[Autorest]    at AutoRest.Modeler.SwaggerModeler.Build(ServiceDefinition serviceDefinition) in /opt/vsts/work/1/s/src/SwaggerModeler.cs:line 66
    cmderr	[Autorest]    at AutoRest.Modeler.Program.<ProcessInternal>d2.MoveNext() in /opt/vsts/work/1/s/src/Program.cs:line 60
    cmderr	[Autorest] --- End of stack trace from previous location where exception was thrown ---
    cmderr	[Autorest]    at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
    cmderr	[Autorest]    at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
    cmderr	[Autorest]    at NewPlugin.<Process>d15.MoveNext()
    cmderr	[Autorest] FATAL: csharp/imodeler1 - FAILED
    cmderr	[Autorest] FATAL: Error: Plugin imodeler1 reported failure.
    cmderr	[Autorest]   Error: Plugin imodeler1 reported failure.
    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 failed [Detail]
  • Failed [Logs]Release - Generate from 432872f. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    cmdout	[automation_generate.sh] [Autorest] https://aka.ms/autorest
    cmdout	[automation_generate.sh] [Autorest] info    | AutoRest core version selected from configuration: 3.7.2.
    cmdout	[automation_generate.sh] [Autorest] SourceMapConsumer.initialize is a no-op when running in node.js
    cmdout	[automation_generate.sh] [Autorest] info    |    Loading AutoRest core      '/home/cloudtest/.autorest/@autorestcore@3.7.2/nodemodules/@autorest/core/dist' (3.7.2)
    cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future.
    cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future.
    cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future.
    cmdout	[automation_generate.sh] [Autorest]   File "/home/cloudtest/.autorest/@autorestpython@5.16.0/node_modules/@autorest/python/autorest/codegen/__init__.py", line 439, in _build_code_modeloptions
    cmdout	[automation_generate.sh] [Autorest]     validate_code_modeloptions(options)
    cmdout	[automation_generate.sh] [Autorest]   File "/home/cloudtest/.autorest/@autorestpython@5.16.0/node_modules/@autorest/python/autorest/codegen/__init__.py", line 83, in _validate_code_modeloptions
    cmdout	[automation_generate.sh] [Autorest]     raise ValueError("--basic-setup-py must be used with --package-version")
    cmdout	[automation_generate.sh] [Autorest] ValueError: --basic-setup-py must be used with --package-version
    cmdout	[automation_generate.sh] [Autorest] fatal   | Process() cancelled due to failure
    cmdout	[automation_generate.sh] [Autorest] error   |   Error: Plugin codegen reported failure.
    cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
    warn	Skip package processing as generation is failed
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 432872f. 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
  • ️✔️armservicefabricmesh [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
️⚠️ azure-sdk-for-js warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 432872f. 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] npm WARN 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]  @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-servicefabricmesh [View full logs]  [Release SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️❌ azure-resource-manager-schemas failed [Detail]
  • Failed [Logs]Release - Generate from 432872f. 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
  • servicefabricmesh/resource-manager [View full logs]  [Release Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 432872f. 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.ServiceFabricMesh [View full logs]  [Release SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

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

TaskHow to fixPriority
AvocadoFix-AvocadoHigh
Semantic validationFix-SemanticValidation-ErrorHigh
Model validationFix-ModelValidation-ErrorHigh
LintDiffFix-LintDiffhigh
If you need further help, please feedback via swagger feedback.

@openapi-workflow-bot
Copy link

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
Copy link

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

@jordan13game
Copy link
Contributor

@o0rubinx0o Remind to create a breakingchange review and fix the ModelValidation error

@JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-ModelValidation CI-FixRequiredOnFailure FixS360

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants