[Hub Generated] Add missing listProducts API to documentation by sdandu21 · Pull Request #19392 · Azure/azure-rest-api-specs

sdandu21 · 2022-06-09T15:24:05Z

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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
  - Adding missing spec for list products to 2017-06-01 version
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.
Service already supports these endpoints
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-06-09T15:24:08Z

Hi, @sdandu21 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-workflow-bot · 2022-06-09T15:24:08Z

Hi, @sdandu21 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-09T15:24:09Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.9.5)
- current:stable/2016-01-01/Product.json compared with base:stable/2016-01-01/Product.json
- current:stable/2017-06-01/Product.json compared with base:stable/2017-06-01/Product.json

Rule	Message
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.AzureStack/stable/2016-01-01/Product.json#L153:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.AzureStack/stable/2017-06-01/Product.json#L153:5

️⚠️LintDiff: 4 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- azurestack/resource-manager/readme.md tag:package-2016-01
- azurestack/resource-manager/readme.md tag:package-2017-06-01
Linted configuring files (Based on target branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- azurestack/resource-manager/readme.md tag:package-2016-01
- azurestack/resource-manager/readme.md tag:package-2017-06-01

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R1001 - OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Products' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L164
⚠️ R1001 - OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Products' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L164
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns a list of products. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L155
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns a list of products. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L155

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4037 - MissingTypeObject	The schema 'DeviceConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L728
`❌` R4037 - MissingTypeObject	The schema 'MarketplaceProductLogUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L751
`❌` R4037 - MissingTypeObject	The schema 'ProductLog' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L776
`❌` R4037 - MissingTypeObject	The schema 'DeviceConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L734
`❌` R4037 - MissingTypeObject	The schema 'MarketplaceProductLogUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L757
`❌` R4037 - MissingTypeObject	The schema 'ProductLog' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L782
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L475
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L582
⚠️ R1001 - OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Products' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L212
⚠️ R1001 - OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Products' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L260
⚠️ R1001 - OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Products' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L212
⚠️ R1001 - OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Products' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L260
⚠️ R1003 - ListInOperationName	Since operation 'Products_GetProducts' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L212
⚠️ R1003 - ListInOperationName	Since operation 'Products_GetProducts' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L212
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'uploadproductlog' in:'Products_UploadLog'. Consider updating the operationId Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L308
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'uploadproductlog' in:'Products_UploadLog'. Consider updating the operationId Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L308
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isSystemExtension Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L428
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: supportMultipleExtensions Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L439
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: vmScaleSetEnabled Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L454
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isCompatible Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L620
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isSystemExtension Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L428
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: supportMultipleExtensions Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L439
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: vmScaleSetEnabled Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L454
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isCompatible Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L626
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns a list of products. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L203
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns the specified product. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L251
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns the specified product. Location: Microsoft.AzureStack/stable/2016-01-01/Product.json#L299
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns a list of products. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L203
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns the specified product. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L251
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Returns the specified product. Location: Microsoft.AzureStack/stable/2017-06-01/Product.json#L299

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

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

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

Validation passed for PoliCheck.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

openapi-pipeline-app · 2022-06-09T15:24:10Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

️✔️azure-sdk-for-go-track2 - armazurestack - 0.1.0
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-azurestack - 1.0.0
❌azure-sdk-for-go - azurestack/mgmt/2017-06-01/azurestack - v65.0.0

+	Function `ProductsClient.GetProductsPreparer` parameter(s) have been changed from `(context.Context, string, string, *DeviceConfiguration)` to `(context.Context, string, string, string, *DeviceConfiguration)`
+	Function `ProductsClient.GetProducts` parameter(s) have been changed from `(context.Context, string, string, *DeviceConfiguration)` to `(context.Context, string, string, string, *DeviceConfiguration)`

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

⚠️Warning [Logs]Release - Generate from 93207d1. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️track2_azure-mgmt-azurestack [View full logs] [Release SDK Changes]
- azure_mgmt_azurestack-1.0.0b1-py3-none-any.whl
- azure-mgmt-azurestack-1.0.0b1.zip
```
info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation RegistrationsOperations.list_by_subscription
```

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

⚠️Warning [Logs]Release - Generate from 93207d1. 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
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

️✔️azure-resourcemanager-azurestack [View full logs] [Release SDK Changes]

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

❌Failed [Logs]Release - Generate from 93207d1. 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
cmderr	[generator automation-v2] [ERROR] total 1 error(s):
cmderr	[generator automation-v2] [ERROR] failed to execute `go generate` '�[33;1mWARNING: Unable to find version for /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/azurestack/armazurestack�[0m
cmderr	[generator automation-v2] [ERROR] Cannot find go module under resourcemanager/azurestack/armazurestack, try to build in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/azurestack/armazurestack
cmderr	[generator automation-v2] [ERROR] ##[command]Cleaning auto-generated files in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/azurestack/armazurestack
cmderr	[generator automation-v2] [ERROR] ##[command]Executing autorest.go in  /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/azurestack/armazurestack
cmderr	[generator automation-v2] [ERROR] AutoRest code generation utility [cli version: 3.6.1; node: v14.19.3]
cmderr	[generator automation-v2] [ERROR] (C) 2018 Microsoft Corporation.
cmderr	[generator automation-v2] [ERROR] https://aka.ms/autorest
cmderr	[generator automation-v2] [ERROR] info    | AutoRest core version selected from configuration: 3.8.2.
cmderr	[generator automation-v2] [ERROR] info    |    Loading AutoRest core      '/home/cloudtest/.autorest/@autorestcore@3.8.2/nodemodules/@autorest/core/dist' (3.8.2)
cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/go' (4.0.0-preview.43 -> 4.0.0-preview.43)
cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/go' (4.0.0-preview.43->4.0.0-preview.43)
cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/modelerfour' (4.23.1 -> 4.23.1)
cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/modelerfour' (4.23.1->4.23.1)
cmderr	[generator automation-v2] [ERROR] warning | PreCheck/SchemaMissingType | The schema 'Operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object'
cmderr	[generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/AzureStack.json:234:5
cmderr	[generator automation-v2] [ERROR] warning | PreCheck/SchemaMissingType | The schema 'Display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object'
cmderr	[generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/AzureStack.json:251:5
cmderr	[generator automation-v2] [ERROR] warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object'
cmderr	[generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/AzureStack.json:272:5
cmderr	[generator automation-v2] [ERROR] warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object'
cmderr	[generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/AzureStack.json:350:5
cmderr	[generator automation-v2] [ERROR] warning | PreCheck/SchemaMissingType | The schema 'DeviceConfiguration' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object'
cmderr	[generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/Product.json:683:5
cmderr	[generator automation-v2] [ERROR] warning | PreCheck/SchemaMissingType | The schema 'MarketplaceProductLogUpdate' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object'
cmderr	[generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/Product.json:706:5
cmderr	[generator automation-v2] [ERROR] warning | PreCheck/SchemaMissingType | The schema 'ProductLog' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object'
cmderr	[generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/Product.json:731:5
cmderr	[generator automation-v2] [ERROR] warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
cmderr	[generator automation-v2] [ERROR] warning | UsingTemporaryFlag | modelerfour.treat-type-object-as-anything options is a temporary flag. It WILL be removed in the future.
cmderr	[generator automation-v2] [ERROR] warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used.
cmderr	[generator automation-v2] [ERROR] fatal   | Error: preexisting go.mod is missing dependency on azcore
cmderr	[generator automation-v2] [ERROR] fatal   | Process() cancelled due to failure
cmderr	[generator automation-v2] [ERROR] error   |   Error: Plugin go-protocol 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.exe": exit status 1
cmderr	[generator automation-v2] [ERROR] ': exit status 1
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2
warn	Skip package processing as generation is failed

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

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

️✔️armazurestack [View full logs] [Preview SDK Changes]
```
info	[Changelog] This is a new package
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from 93207d1. 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]  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] npm 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-azurestack [View full logs] [Release SDK Changes]
- azure-arm-azurestack-3.0.0-beta.3.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

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

⚠️Warning [Logs]Release - Generate from 93207d1. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation

️✔️azurestack [View full logs]

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 93207d1. 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.Stack [View full logs] [Release SDK Changes]
- Az.Stack.0.1.0.nupkg

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

openapi-workflow-bot · 2022-06-09T15:27:00Z

NewApiVersionRequired reason:

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

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

openapi-workflow-bot · 2022-06-09T15:27:00Z

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.

sdandu21 · 2022-06-09T16:30:31Z

There is no change to the service because the path to ListProducts is already available in the API version but was not added to the spec. We received an S360 Swagger Completeness issue because the path was not documented here.

openapi-workflow-bot · 2022-06-09T16:31:55Z

Hi, @sdandu21 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

openapi-workflow-bot · 2022-06-09T16:31:55Z

Hi, @sdandu21 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

raosuhas · 2022-06-10T01:02:39Z

        }
      }
    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/listProducts": {


listProducts

why do you need a POST .. this should really be modelled as a GET collection at the top level i.e :

GET : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products

This PR is for fixing a swagger completeness item in s360. This API has been around for the entire lifetime of the RP, but wasn't documented for some reason. Changing how we model the operation would be a breaking change, and also wouldn't fix the swagger completeness issue. I don't know why this didn't show up earlier in swagger completeness - logs show the operation has been in use for a long time.

This action is modeled as a POST request because it has a body, the DeviceConfigurationParameter in the swagger JSON.

Further, this action is identical to the POST ...{productName}/getProducts action. I don't know why they both exist - anyone who wrote these APIs is long gone.

I think the reason you have identical apis is that customers wanted to call this in ARM templates which can only be done for POST actions prefixed with "list*" as explained here : https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/template-functions-resource#list . You probably should start planning to deprecate the getproducts one.

Can you please annotate the "DeviceConfigurationParameter" as coming from request body so that it is clear

You would need to work with the breaking change board to get the "NewApiversionRequired" Tag removed. Once that is done then please remove the "ARMChangesRequested" label and we can do the arm sign off

Thank you. Can you give an example of what we should do to annotate the parameter? If you look at the parameter definition further down the file it does say "in": "body". Not sure what else we should do.

raosuhas · 2022-06-10T01:03:35Z

For arm api please fix the above comment and also get the newapiversion approval. Once that is done, please remove the "ARMChangesRequested" label when you want the API reviewer to look at this review again

zcollins0 · 2022-06-10T16:56:57Z

Responded to comment above, requesting re-review.

openapi-workflow-bot · 2022-06-10T21:40:37Z

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

openapi-workflow-bot · 2022-06-10T21:40:38Z

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

zcollins0 · 2022-06-10T22:43:10Z

@sdandu21 this API is also available on version 2016-01-01

openapi-workflow-bot · 2022-06-21T01:42:21Z

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

rkmanda

Add specification for list products

4dd8dbc

openapi-pipeline-app Bot added the NewApiVersionRequired label Jun 9, 2022

openapi-workflow-bot Bot added FixS360 labels Jun 9, 2022

openapi-workflow-bot Bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 9, 2022

sdandu21 marked this pull request as ready for review June 9, 2022 16:34

openapi-assignment-bot Bot assigned honghr Jun 9, 2022

raosuhas reviewed Jun 10, 2022

View reviewed changes

raosuhas added the ARMChangesRequested label Jun 10, 2022

openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 10, 2022

zcollins0 removed the ARMChangesRequested label Jun 10, 2022

openapi-workflow-bot Bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 10, 2022

raosuhas added the ARMChangesRequested label Jun 10, 2022

openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 10, 2022

zcollins0 added the BreakingChangeReviewRequired label Jun 10, 2022

zcollins0 changed the title ~~[Hub Generated] Review request for Microsoft.AzureStack to add version stable/2017-06-01~~ [Hub Generated] Add missing listProducts API to documentation Jun 10, 2022

Add spec to 2016-01-01

1c597ec

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

sdandu21 removed the ARMChangesRequested label Jun 20, 2022

openapi-workflow-bot Bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 20, 2022

rkmanda added the ARMChangesRequested label Jun 21, 2022

openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 21, 2022

rkmanda added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 21, 2022

openapi-workflow-bot Bot removed the ARMChangesRequested label Jun 21, 2022

rkmanda approved these changes Jun 21, 2022

View reviewed changes

rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 21, 2022

openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 21, 2022

honghr merged commit 93207d1 into Azure:main Jun 22, 2022

Conversation

sdandu21 commented Jun 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot Bot commented Jun 9, 2022

Uh oh!

openapi-workflow-bot Bot commented Jun 9, 2022

Uh oh!

openapi-pipeline-app Bot commented Jun 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app Bot commented Jun 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-workflow-bot Bot commented Jun 9, 2022

Uh oh!

openapi-workflow-bot Bot commented Jun 9, 2022

Uh oh!

sdandu21 commented Jun 9, 2022

Uh oh!

openapi-workflow-bot Bot commented Jun 9, 2022

Uh oh!

openapi-workflow-bot Bot commented Jun 9, 2022

Uh oh!

raosuhas Jun 10, 2022

Choose a reason for hiding this comment

Uh oh!

zcollins0 Jun 10, 2022

Choose a reason for hiding this comment

Uh oh!

zcollins0 Jun 10, 2022

Choose a reason for hiding this comment

Uh oh!

raosuhas Jun 10, 2022

Choose a reason for hiding this comment

Uh oh!

zcollins0 Jun 10, 2022

Choose a reason for hiding this comment

Uh oh!

raosuhas commented Jun 10, 2022

Uh oh!

zcollins0 commented Jun 10, 2022

Uh oh!

openapi-workflow-bot Bot commented Jun 10, 2022

Uh oh!

openapi-workflow-bot Bot commented Jun 10, 2022

Uh oh!

zcollins0 commented Jun 10, 2022

Uh oh!

openapi-workflow-bot Bot commented Jun 21, 2022

Uh oh!

rkmanda left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

sdandu21 commented Jun 9, 2022 •

edited

Loading

openapi-pipeline-app Bot commented Jun 9, 2022 •

edited

Loading

openapi-pipeline-app Bot commented Jun 9, 2022 •

edited

Loading