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

iothub: fixing a constant naming bug

Open tombuildsstuff opened this issue 2 years ago • 12 comments

These two constants have the same name but different values, thus aren't valid.

tombuildsstuff avatar Nov 30 '22 14:11 tombuildsstuff

Swagger pipeline started successfully, please wait for status update in this comment.

Swagger pipeline started successfully, please wait for status update in this comment.

Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon.

ghost avatar Nov 30 '22 14:11 ghost

Hi, @tombuildsstuff. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

ghost avatar Jul 09 '23 16:07 ghost

Swagger Validation Report

️❌BreakingChange: 17 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
iothub.json 2022-04-30-preview(495983c) 2022-04-30-preview(main)
iothub.json 2022-11-15-preview(495983c) 2022-11-15-preview(main)
iothub.json 2023-06-30-preview(495983c) 2023-06-30-preview(main)
iothub.json 2021-07-02(495983c) 2021-07-02(main)
iothub.json 2023-06-30(495983c) 2023-06-30(main)
Rule Message
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/preview/2022-04-30-preview/iothub.json#L3297:9
Old: Microsoft.Devices/preview/2022-04-30-preview/iothub.json#L3297:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/preview/2022-04-30-preview/iothub.json#L4077:9
Old: Microsoft.Devices/preview/2022-04-30-preview/iothub.json#L4092:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/preview/2022-11-15-preview/iothub.json#L3319:9
Old: Microsoft.Devices/preview/2022-11-15-preview/iothub.json#L3319:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/preview/2022-11-15-preview/iothub.json#L4117:9
Old: Microsoft.Devices/preview/2022-11-15-preview/iothub.json#L4114:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L3319:9
Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L3319:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L4099:9
Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L4114:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/stable/2021-07-02/iothub.json#L3180:9
Old: Microsoft.Devices/stable/2021-07-02/iothub.json#L3180:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/stable/2021-07-02/iothub.json#L3984:9
Old: Microsoft.Devices/stable/2021-07-02/iothub.json#L3981:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/stable/2023-06-30/iothub.json#L3294:9
Old: Microsoft.Devices/stable/2023-06-30/iothub.json#L3294:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Devices/stable/2023-06-30/iothub.json#L4082:9
Old: Microsoft.Devices/stable/2023-06-30/iothub.json#L4095:9
1019 - RemovedEnumValue The new version is removing enum value(s) 'DigitalTwinChangeEvents, MqttBrokerMessages' from the old version.
New: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L3319:9
Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L3319:9
1019 - RemovedEnumValue The new version is removing enum value(s) 'DigitalTwinChangeEvents, MqttBrokerMessages' from the old version.
New: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L4099:9
Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L4114:9
1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: Microsoft.Devices/preview/2022-04-30-preview/iothub.json#L3333:9
Old: Microsoft.Devices/preview/2022-04-30-preview/iothub.json#L3348:9
1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: Microsoft.Devices/preview/2022-11-15-preview/iothub.json#L3373:9
Old: Microsoft.Devices/preview/2022-11-15-preview/iothub.json#L3370:9
1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L3355:9
Old: Microsoft.Devices/preview/2023-06-30-preview/iothub.json#L3370:9
1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: Microsoft.Devices/stable/2021-07-02/iothub.json#L3216:9
Old: Microsoft.Devices/stable/2021-07-02/iothub.json#L3229:9
1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: Microsoft.Devices/stable/2023-06-30/iothub.json#L3330:9
Old: Microsoft.Devices/stable/2023-06-30/iothub.json#L3343:9
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 11 Errors, 0 Warnings failed [Detail]
Rule Message
INVALID_REQUEST_PARAMETER api-version 2018-04-01 is not equal to swagger version
Url: Microsoft.Devices/preview/2022-04-30-preview/iothub.json#L406:14
ExampleUrl: preview/2022-04-30-preview/examples/iothub_stats.json#L2:17
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.Devices/preview/2022-04-30-preview/iothub.json#L1733:22
ExampleUrl: preview/2022-04-30-preview/examples/IotHub_ManualFailover.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.Devices/stable/2021-07-02/iothub.json#L270:22
ExampleUrl: stable/2021-07-02/examples/iothub_delete.json
INVALID_REQUEST_PARAMETER api-version 2018-04-01 is not equal to swagger version
Url: Microsoft.Devices/stable/2021-07-02/iothub.json#L388:14
ExampleUrl: stable/2021-07-02/examples/iothub_stats.json#L2:17
INVALID_FORMAT Object didn't pass validation for format date-time-rfc1123: 2020-03-26T21:20:57Z
Url: Microsoft.Devices/stable/2021-07-02/iothub.json#L3521:42
ExampleUrl: stable/2021-07-02/examples/iothub_routingendpointhealth.json#L15:46
INVALID_FORMAT Object didn't pass validation for format date-time-rfc1123: 2020-03-26T21:20:57Z
Url: Microsoft.Devices/stable/2021-07-02/iothub.json#L3521:42
ExampleUrl: stable/2021-07-02/examples/iothub_routingendpointhealth.json#L27:46
INVALID_FORMAT Object didn't pass validation for format date-time-rfc1123: 2020-03-26T21:24:57Z
Url: Microsoft.Devices/stable/2021-07-02/iothub.json#L3526:32
ExampleUrl: stable/2021-07-02/examples/iothub_routingendpointhealth.json#L16:36
INVALID_FORMAT Object didn't pass validation for format date-time-rfc1123: 2020-03-26T21:24:57Z
Url: Microsoft.Devices/stable/2021-07-02/iothub.json#L3526:32
ExampleUrl: stable/2021-07-02/examples/iothub_routingendpointhealth.json#L28:36
INVALID_FORMAT Object didn't pass validation for format date-time-rfc1123: 2020-03-26T21:24:57Z
Url: Microsoft.Devices/stable/2021-07-02/iothub.json#L3516:31
ExampleUrl: stable/2021-07-02/examples/iothub_routingendpointhealth.json#L26:35
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.Devices/stable/2021-07-02/iothub.json#L1716:22
ExampleUrl: stable/2021-07-02/examples/IotHub_ManualFailover.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.Devices/stable/2021-07-02/iothub.json#L2004:22
ExampleUrl: stable/2021-07-02/examples/iothub_deleteprivateendpointconnection.json
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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).
️️✔️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. 
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

azure-sdk-for-go - sdk/resourcemanager/iothub/armiothub - Approved - 2.0.0
+	Function `*timeRFC1123.UnmarshalText` has been removed
+	Function `*timeRFC3339.Parse` has been removed
+	Function `*timeRFC3339.UnmarshalText` has been removed
+	Function `timeRFC1123.MarshalText` has been removed
+	Function `timeRFC3339.MarshalText` has been removed


️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from b277c92428b4d9c405c7aa6eeeffbe5c4b5093cb. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  • ️✔️Azure.ResourceManager.IotHub [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from b277c92428b4d9c405c7aa6eeeffbe5c4b5093cb. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    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] notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.3
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-iothub [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from b277c92428b4d9c405c7aa6eeeffbe5c4b5093cb. 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 -> 23.3.1
    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 -> 23.3.1
    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-iothub [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from b277c92428b4d9c405c7aa6eeeffbe5c4b5093cb. 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/iothub/armiothub [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Function `timeRFC1123.MarshalText` has been removed
    info	[Changelog] - Function `*timeRFC1123.UnmarshalText` has been removed
    info	[Changelog] - Function `timeRFC3339.MarshalText` has been removed
    info	[Changelog] - Function `*timeRFC3339.Parse` has been removed
    info	[Changelog] - Function `*timeRFC3339.UnmarshalText` has been removed
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New function `dateTimeRFC1123.MarshalText() ([]byte, error)`
    info	[Changelog] - New function `*dateTimeRFC1123.UnmarshalText([]byte) error`
    info	[Changelog] - New function `dateTimeRFC3339.MarshalText() ([]byte, error)`
    info	[Changelog] - New function `*dateTimeRFC3339.Parse(string) error`
    info	[Changelog] - New function `*dateTimeRFC3339.UnmarshalText([]byte) error`
    info	[Changelog]
    info	[Changelog] Total 5 breaking change(s), 5 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from b277c92428b4d9c405c7aa6eeeffbe5c4b5093cb. 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
    cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
  • ️✔️@azure/arm-iothub [View full logs]  [Preview SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from b277c92428b4d9c405c7aa6eeeffbe5c4b5093cb. 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] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.3
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
    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
  • ️✔️iothub [View full logs]  [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from b277c92428b4d9c405c7aa6eeeffbe5c4b5093cb. 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
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ⚠️Az.iothub.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.iothub.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/iothub/armiothub Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Java azure-resourcemanager-iothub Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
.Net Azure.ResourceManager.IotHub Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
JavaScript @azure/arm-iothub Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Swagger Microsoft.Devices Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

ping @rkmanda @tianxchen-ms - any update on this one?

tombuildsstuff avatar Jul 13 '23 14:07 tombuildsstuff

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.

Hi @tombuildsstuff! The automation detected breaking changes in this pull request. As a result, it added the BreakingChangeReviewRequired label.

You cannot proceed with merging this PR until you complete one of the following action items:

ACTION ITEM ALTERNATIVE A: Fix the breaking change.
Please consult the documentation provided in the relevant validation failures.

ACTION ITEM ALTERNATIVE B: Request approval.
Alternatively, if you cannot fix the breaking changes, then you can request an approval for them. Please follow the process described in the High-level Breaking Change Process doc.

ACTION ITEM ALTERNATIVE C: Report false positive.
If you think there are no breaking changes, i.e. the validation should pass yet it fails, then proceed as explained in ACTION ITEM ALTERNATIVE B.
This applies even if the breaking change tool fails with internal runtime error. In such case a manual breaking change review is necessary.

Hi @tombuildsstuff! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.

TaskHow to fixPriority
AvocadoFix-AvocadoHigh
Semantic ValidationFix-SemanticValidation-ErrorHigh
Model ValidationFix-ModelValidation-ErrorHigh
LintDiffFix-LintDiffHigh

If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.

Per the comment above:

There are no breaking changes.

So AFAICT this PR is good to review / the build failures are misleading and this is waiting on the Service Team to review this

tombuildsstuff avatar Jul 25 '23 11:07 tombuildsstuff

Hi @rkmanda, @tianxchen-ms, since this PR has been signedoff, could you kindly help approve and merge this PR? Thanks.

ms-zhenhua avatar Jul 27 '23 23:07 ms-zhenhua

Pl fix the model validation and prettier required checks

rkmanda avatar Aug 16 '23 02:08 rkmanda

Once you have fixed the modelvalidation and prettier required checks, add the label "Mergerequested" to bring this back to the merge queue

rkmanda avatar Aug 17 '23 01:08 rkmanda

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has at least one breaking change (label: BreakingChangeReviewRequired). See the PR description for help.
  • ❌ The required check named Swagger ModelValidation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

@rkmanda the prettier check has been fixed - checking the modelvalidation check, this is an existing failure, so that would need to be addressed by the Service Team outside of this PR?

I believe that's everything needed for this one, but lmk if there's anything else?

tombuildsstuff avatar Nov 13 '23 08:11 tombuildsstuff

@rkmanda any update on this one?

tombuildsstuff avatar Nov 23 '23 08:11 tombuildsstuff

@tombuildsstuff I have removed the Approved-BreakingChange label because it is obsolete. Your PR will have to be re-approved. Please follow the instructions at https://aka.ms/brch. If you provide the reason why your PR was approved in the first place, this will speed up the process and help the Breaking Change Review Board apply appropriate new label. Apologies for the inconvenience!

konrad-jamrozik avatar Mar 12 '24 03:03 konrad-jamrozik