Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update TypeSpec for DeviceRegistry #29319

Merged
merged 13 commits into from
Jun 11, 2024
Merged

Conversation

live1206
Copy link
Member

@live1206 live1206 commented Jun 4, 2024

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.

PR review workflow diagram

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

spec_pr_review_workflow_diagram

Purpose of this PR

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

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • 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.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • 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 ARM review (PR workflow diagram Step 2), 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.

Copy link

openapi-pipeline-app bot commented Jun 4, 2024

Next Steps to Merge

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

Copy link

openapi-pipeline-app bot commented Jun 4, 2024

Swagger Validation Report

️❌BreakingChange: 39 Errors, 2 Warnings failed [Detail]
Compared specs (v0.10.9) new version base version
deviceregistry.json 2023-11-01-preview(816a954) 2023-11-01-preview(main)

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

Rule Message
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AssetEndpointProfileUpdate' removed or renamed?
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AssetEndpointProfileUpdateProperties' removed or renamed?
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AssetUpdate' removed or renamed?
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AssetUpdateProperties' removed or renamed?
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'TransportAuthenticationUpdate' removed or renamed?
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'UserAuthenticationUpdate' removed or renamed?
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'UsernamePasswordCredentialsUpdate' removed or renamed?
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'X509CredentialsUpdate' removed or renamed?
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L822:3
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406:13
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L858:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L953:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L920:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L968:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1366:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1565:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1370:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1569:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L924:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L972:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L715:13
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L715:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L827:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1171:9
1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L996:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1036:9
1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1015:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1054:9
1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1036:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1074:9
1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1015:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1201:9
1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1036:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1221:9
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L909:7
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L962:7
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1334:7
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1533:7
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1382:7
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1596:7
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1400:7
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1623:7
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1317:7
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1471:7
1034 - AddedRequiredProperty The new version has new required property 'usernameReference, passwordReference' that was not found in the old version.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1366:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1565:9
1034 - AddedRequiredProperty The new version has new required property 'certificateReference' that was not found in the old version.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1370:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1569:9
1034 - AddedRequiredProperty The new version has new required property 'mode' that was not found in the old version.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L920:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L968:9
1034 - AddedRequiredProperty The new version has new required property 'ownCertificates' that was not found in the old version.
New: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L924:9
Old: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L972:9
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 13 Errors, 0 Warnings failed [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2023-11 package-preview-2023-11(816a954) package-preview-2023-11(main)

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

Rule Message Related RPC [For API reviewers]
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:targetAddress.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:mode.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:usernameReference.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:passwordReference.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:certificateReference.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:ownCertificates.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:extendedLocation.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L715
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L715
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:assetEndpointProfileUri.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L715
RPC-Patch-V1-10
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:extendedLocation.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L715
RPC-Patch-V1-10


The following errors/warnings exist before current PR submission:

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

Rule Message
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:mode.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L406
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L1045
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L65
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L72
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L78
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L101
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L104
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L117
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L140
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L143
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L156
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L179
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L182
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L185
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L188
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L195
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L201
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L221
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L224
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L227
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L240
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L263
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L266
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L269
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L292
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L310
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L313
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L316
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L361
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L383
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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?

Copy link

openapi-pipeline-app bot commented Jun 4, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 8aa48edd31e21dbb1bc880f640041de6548aa8ad. 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
    warn		specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/deviceregistry/armdeviceregistry [Preview SDK Changes]
️❌ azure-sdk-for-java failed [Detail]
  • Code Generator Failed in generating from 8aa48edd31e21dbb1bc880f640041de6548aa8ad. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-deviceregistry [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-deviceregistry-1.0.0-beta.2-sources.jar
    • azure-resourcemanager-deviceregistry-1.0.0-beta.2.jar
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from 8aa48edd31e21dbb1bc880f640041de6548aa8ad. 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] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    cmderr	[automation_init.sh] npm notice
    cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
    cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
    cmderr	[automation_init.sh] npm notice To update run: npm install -g npm@10.8.1
    cmderr	[automation_init.sh] npm notice
    warn		specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-mgmt-deviceregistry [Preview SDK Changes]
    • azure-mgmt-deviceregistry-1.0.0b1.zip
    • azure_mgmt_deviceregistry-1.0.0b1-py3-none-any.whl
️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed in generating from 8aa48edd31e21dbb1bc880f640041de6548aa8ad. 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
    warn		specification/deviceregistry/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  131 |                GeneratePackage `
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  807 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  131 |                GeneratePackage `
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact
  • Azure.ResourceManager.DeviceRegistry [Preview SDK Changes]
    info	[Changelog]
Posted by Swagger Pipeline | How to fix these errors?

@live1206
Copy link
Member Author

live1206 commented Jun 7, 2024

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@live1206
Copy link
Member Author

live1206 commented Jun 7, 2024

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@live1206
Copy link
Member Author

Given the current API version is still preview, breaking changes should be allowed for it.

@live1206 live1206 added the BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. label Jun 11, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Jun 11, 2024
@live1206 live1206 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 11, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 11, 2024
@live1206 live1206 merged commit d1bbbb3 into Azure:main Jun 11, 2024
29 of 32 checks passed
@live1206 live1206 deleted the update-device-registry branch June 11, 2024 07:48
@davidemontanari
Copy link
Member

davidemontanari commented Jun 11, 2024

@live1206, @ArthurMa1978 @pshao25 - Those changes are breaking the swagger validation on our side for the fields moved from string to url! This PR needs to be reverted since it's breaking our public APIs!

@JeffreyRichter
Copy link
Member

Given the current API version is still preview, breaking changes should be allowed for it.

No, this is not how Azure policy works. You have customers using the preview api-version and breaking those customers is not allowed. Instead, Azure policy is to ship a new api-version and then stop supporting the old api-version after 90 days. Now, customers have 90 days to migrate from the old to the new adopting the breaking changes.

@konrad-jamrozik
Copy link

konrad-jamrozik commented Jun 11, 2024

@live1206 you wrote:

Given the current API version is still preview, breaking changes should be allowed for it.

But this is not correct: it is not allowed to break a deployed API version, even when in preview, per this doc.

There is a minor bug in the tooling in which it should have added VersioningReviewRequired instead of BreakingChangeReviewRequired (Azure/azure-sdk-tools#8429) but this doesn't change the fact this change was not allowed.

Per this Teams post by @davidemontanari looks like merging this PR caused breakage as captured by this Sev 2:

Revert PR by @davidemontanari:

FYI @JeffreyRichter @mikekistler

rkmanda added a commit that referenced this pull request Jun 11, 2024
This reverts commit d1bbbb3.

Co-authored-by: Roopesh Manda <rmanda@microsoft.com>
markcowl pushed a commit to markcowl/azure-rest-api-specs that referenced this pull request Jun 11, 2024
* Update TypeSpec for DeviceRegistry

* add client.tsp

* fix model validation

* fix example

* fix example

* remove unused csharp option

* update client.tsp

* fix tsp validation

* fix more tsp validation

* update csharp option
@live1206
Copy link
Member Author

@davidemontanari @JeffreyRichter @konrad-jamrozik
Sorry for rushing this out without more thoughts, lesson learned.

@davidemontanari I will try to add a new version for the needed change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager RPaaS TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants