azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Siddiavinashmsft help microsoft.help 2024 03 01 preview

Open siddiavinashmsft opened this issue 1 year ago • 12 comments

ARM (Control Plane) API Specification Update Pull Request

[!TIP] Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

[!NOTE] As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • [ ] New resource provider.
  • [x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • [ ] Update existing version to fix OpenAPI spec quality issues in S360.
  • [ ] Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:

  • [ ] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • [ ] I have reviewed following Resource Provider guidelines, including ARM resource provider contract and REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
  • For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run. This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

siddiavinashmsft avatar Mar 15 '24 19:03 siddiavinashmsft

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge.

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 21 Errors, 3 Warnings failed [Detail]
Compared specs (v0.10.7) new version base version
help.json 2024-03-01-preview(56d57e7) 2023-06-01(main)
help.json 2024-03-01-preview(56d57e7) 2023-09-01-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule Message
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/{scope}/providers/Microsoft.Help/discoverySolutions' removed or restructured?
Old: Microsoft.Help/stable/2023-06-01/help.json#L215:5
1008 - ModifiedOperationId The operation id has been changed from 'Diagnostics_CheckNameAvailability' to 'CheckNameAvailability_Post'. This will impact generated code.
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L75:7
Old: Microsoft.Help/stable/2023-06-01/help.json#L75:7
1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L413:9
Old: common-types/resource-management/v3/types.json#L411:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L204:9
Old: common-types/resource-management/v3/types.json#L204:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L210:9
Old: common-types/resource-management/v3/types.json#L209:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one 'AutoRest.Swagger.Model.Schema'.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1179:9
Old: Microsoft.Help/stable/2023-06-01/help.json#L566:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1182:9
Old: Microsoft.Help/stable/2023-06-01/help.json#L570:9
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'solutionId' renamed or removed?
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1160:7
Old: Microsoft.Help/stable/2023-06-01/help.json#L561:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'solutionType' renamed or removed?
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1160:7
Old: Microsoft.Help/stable/2023-06-01/help.json#L561:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'description' renamed or removed?
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1160:7
Old: Microsoft.Help/stable/2023-06-01/help.json#L561:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'requiredParameterSets' renamed or removed?
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1160:7
Old: Microsoft.Help/stable/2023-06-01/help.json#L561:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'requiredParameterSets' renamed or removed?
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1174:7
Old: Microsoft.Help/stable/2023-06-01/help.json#L561:7
1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L979:9
Old: Microsoft.Help/stable/2023-06-01/help.json#L340:9
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1179:9
Old: Microsoft.Help/stable/2023-06-01/help.json#L566:9
:warning: 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1145:9
Old: Microsoft.Help/stable/2023-06-01/help.json#L546:9
:warning: 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Help/preview/2024-03-01-preview/help.json#L1179:9
Old: Microsoft.Help/stable/2023-06-01/help.json#L566:9


The following breaking changes are detected by comparison with the latest preview version:

Rule Message
:warning: 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/{scope}/providers/Microsoft.Help/discoverySolutions' removed or restructured?
Old: Microsoft.Help/preview/2023-09-01-preview/help.json#L215:5
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 5 Errors, 9 Warnings failed [Detail]
Compared specs (v2.2.0) new version base version
package-2024-03-01-preview package-2024-03-01-preview(56d57e7) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1270
RPC-Policy-V1-05, RPC-Put-V1-23
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1739
RPC-Policy-V1-05, RPC-Put-V1-23
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1739
RPC-Policy-V1-05, RPC-Put-V1-23
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1753
RPC-Policy-V1-05, RPC-Put-V1-23
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1765
RPC-Policy-V1-05, RPC-Put-V1-23
:warning: UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Solution_Create
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L466
:warning: UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Solution_Get
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L503
:warning: UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Solution_Get
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L807
:warning: ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L815
:warning: PostOperationIdContainsUrlVerb OperationId should contain the verb: 'discoversolutions' in:'DiscoverySolutionNLPTenantScope_Post'. Consider updating the operationId
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L820
:warning: ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L856
:warning: PostOperationIdContainsUrlVerb OperationId should contain the verb: 'discoversolutions' in:'DiscoverySolutionNLPSubscriptionScope_Post'. Consider updating the operationId
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L861
:warning: UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Discovery Solutions using issue summary and service id.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L892
:warning: AllProxyResourcesShouldHaveDelete The resource SimplifiedSolutionsResource does not have a corresponding delete operation.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1729
RPC-Delete-V1-05


The following errors/warnings exist before current PR submission:

Rule Message
XMSLongRunningOperationProperty If an operation's (PUT/POST/PATCH/DELETE) responses have Location or Azure-AsyncOperation headers then it MUST have the property x-ms-long-running-operation set to true
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L674
XMSLongRunningOperationProperty If an operation's (PUT/POST/PATCH/DELETE) responses have Location or Azure-AsyncOperation headers then it MUST have the property x-ms-long-running-operation set to true
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L715
XMSLongRunningOperationProperty If an operation's (PUT/POST/PATCH/DELETE) responses have Location or Azure-AsyncOperation headers then it MUST have the property x-ms-long-running-operation set to true
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L756
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L927
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L941
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L941
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L957
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L967
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1259
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1288
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1308
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1955
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1969
:warning: PostOperationIdContainsUrlVerb OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Post'. Consider updating the operationId
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L80
:warning: EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L905
:warning: AllProxyResourcesShouldHaveDelete The resource DiagnosticResource does not have a corresponding delete operation.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L936
:warning: AllProxyResourcesShouldHaveDelete The resource SolutionResource does not have a corresponding delete operation.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1278
:warning: AllProxyResourcesShouldHaveDelete The resource TroubleshooterResource does not have a corresponding delete operation.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L1945
:warning: EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L2080
:warning: EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L2223
:warning: ParameterNotUsingCommonTypes Not using the common-types defined parameter 'scope'.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L2508
:warning: ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L2517
:warning: ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Help/preview/2024-03-01-preview/help.json#L2564
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule Message
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /{}/providers/Microsoft.Help/discoverySolutions is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/help/resource-manager/readme.md
json: Microsoft.Help/preview/2023-09-01-preview/help.json
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning [Logs] Generate from 7023698235df158332ded9f800496ae8b1ce037d. 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]
    cmderr	[automation_generate.sh]  New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️azure-mgmt-selfhelp [View full logs]  [Preview SDK Changes]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from 7023698235df158332ded9f800496ae8b1ce037d. 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
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-selfhelp [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 7023698235df158332ded9f800496ae8b1ce037d. 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
  • ️✔️sdk/resourcemanager/selfhelp/armselfhelp [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 7023698235df158332ded9f800496ae8b1ce037d. 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
    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-selfhelp [View full logs]  [Preview SDK Changes]
️❌ azure-resource-manager-schemas failed [Detail]
  • Failed [Logs] Generate from 7023698235df158332ded9f800496ae8b1ce037d. 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] notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[initScript.sh] npm notice
    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
  • help/resource-manager [View full logs
️⚠️ azure-powershell warning [Detail]
  • ⚠️Warning [Logs] Generate from 7023698235df158332ded9f800496ae8b1ce037d. 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.help.DefaultTag [View full logs]  [Preview SDK Changes]
  • ⚠️Az.SelfHelp.Autorest [View full logs]  [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

We opened two PR's to the private repo. Both have been approved. We also got the breaking change approval. PR1 Link - #15862 PR2 Link - #16821

siddiavinashmsft avatar Mar 15 '24 21:03 siddiavinashmsft

please also fix errors in the following links: https://github.com/Azure/azure-rest-api-specs/pull/28285/checks?check_run_id=22806988984 https://github.com/Azure/azure-rest-api-specs/pull/28285/checks?check_run_id=22806989095

ms-zhenhua avatar Mar 19 '24 05:03 ms-zhenhua

please also fix errors in the following links: https://github.com/Azure/azure-rest-api-specs/pull/28285/checks?check_run_id=22806988984 https://github.com/Azure/azure-rest-api-specs/pull/28285/checks?check_run_id=22806989095

Fixed the errors.

I see few errors as part of Swagger LintDiff with respet to AdditionalProperties. We have address that in the PR #16821which has been signed off by Arm.

Comment link where it was addressed: Link

siddiavinashmsft avatar Mar 19 '24 15:03 siddiavinashmsft

@siddiavinashmsft , the following error can be found in the CI check result page. The conflict names need to be resolved.

fatal   | Error: type SelfHelpSolutionResource was renamed to SolutionResource which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] type SelfHelpReplacementMaps was renamed to ReplacementMaps which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] type SelfHelpSection was renamed to Section which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] fatal   | Process() cancelled due to failure
cmderr	[generator automation-v2] [ERROR] error   |   Error: Plugin go-transform-m4 reported failure.
cmderr	[generator automation-v2] [ERROR] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1
cmderr	[generator automation-v2] [ERROR] ': exit status 1

raych1 avatar Mar 21 '24 10:03 raych1

@siddiavinashmsft , the following error can be found in the CI check result page. The conflict names need to be resolved.

fatal   | Error: type SelfHelpSolutionResource was renamed to SolutionResource which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] type SelfHelpReplacementMaps was renamed to ReplacementMaps which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] type SelfHelpSection was renamed to Section which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] fatal   | Process() cancelled due to failure
cmderr	[generator automation-v2] [ERROR] error   |   Error: Plugin go-transform-m4 reported failure.
cmderr	[generator automation-v2] [ERROR] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1
cmderr	[generator automation-v2] [ERROR] ': exit status 1

@raych1

This is incorrect. We have all the types present, i.e SelfHelpSolutionResource, SelfHelpReplacementMaps, SelfHelpSection. There was no renaming done.

SelfHelpSolutionResource : code link

SolutionResource: code link

Also to note: Other Sdk have been passed. Only Go is the one that failed.

siddiavinashmsft avatar Mar 21 '24 17:03 siddiavinashmsft

@siddiavinashmsft , the following error can be found in the CI check result page. The conflict names need to be resolved.

fatal   | Error: type SelfHelpSolutionResource was renamed to SolutionResource which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] type SelfHelpReplacementMaps was renamed to ReplacementMaps which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] type SelfHelpSection was renamed to Section which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] fatal   | Process() cancelled due to failure
cmderr	[generator automation-v2] [ERROR] error   |   Error: Plugin go-transform-m4 reported failure.
cmderr	[generator automation-v2] [ERROR] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1
cmderr	[generator automation-v2] [ERROR] ': exit status 1

@raych1

This is incorrect. We have all the types present, i.e SelfHelpSolutionResource, SelfHelpReplacementMaps, SelfHelpSection. There was no renaming done.

SelfHelpSolutionResource : code link

SolutionResource: code link

Also to note: Other Sdk have been passed. Only Go is the one that failed.

@siddiavinashmsft , for Go SDK, the ServiceName would be removed from the generated type's name. Don't have service name as prefix of the model name which might cause the conflicts.

raych1 avatar Mar 22 '24 00:03 raych1

@siddiavinashmsft , the following error can be found in the CI check result page. The conflict names need to be resolved.

fatal   | Error: type SelfHelpSolutionResource was renamed to SolutionResource which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] type SelfHelpReplacementMaps was renamed to ReplacementMaps which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] type SelfHelpSection was renamed to Section which collides with an existing type name
cmderr	[generator automation-v2] [ERROR] fatal   | Process() cancelled due to failure
cmderr	[generator automation-v2] [ERROR] error   |   Error: Plugin go-transform-m4 reported failure.
cmderr	[generator automation-v2] [ERROR] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1
cmderr	[generator automation-v2] [ERROR] ': exit status 1

@raych1 This is incorrect. We have all the types present, i.e SelfHelpSolutionResource, SelfHelpReplacementMaps, SelfHelpSection. There was no renaming done. SelfHelpSolutionResource : code link SolutionResource: code link Also to note: Other Sdk have been passed. Only Go is the one that failed.

@siddiavinashmsft , for Go SDK, the ServiceName would be removed from the generated type's name. Don't have service name as prefix of the model name which might cause the conflicts.

@raych1 Renaming the models did not help entirely.

We got another error: Error: client SelfHelpSolutionClient was renamed to SolutionClient which collides with an existing client name

I am not sure how the "SelfHelpSolutionClient " is created. Any suggestions here? Also, can we get an exception for this case? Since other Sdk's are passing. Note: We have an API called SelfHelp.

siddiavinashmsft avatar Mar 22 '24 19:03 siddiavinashmsft

/pr RequestMerge

siddiavinashmsft avatar Apr 02 '24 14:04 siddiavinashmsft