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

[Microsoft.DeviceRegistry] Fixed operationIds in examples for API version 2023-11-01-preview #28842

Merged
merged 7 commits into from May 10, 2024

Conversation

davidemontanari
Copy link
Member

@davidemontanari davidemontanari commented Apr 25, 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.

Note

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

PR review workflow diagram

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

diagram

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

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

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

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

Click here to see the diagram footnotes

Diagram footnotes

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

Purpose of this PR

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

  • New resource provider.
  • 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:
    • Fixed operationIds in examples for Microsoft.DeviceRegistry API version 2023-11-01-preview.
    • Removed @Autorest.example(...) decorators in TypeSpec files.

Due diligence checklist

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

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

Additional information

Viewing API changes

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

Suppressing failures

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

Getting help

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

Copy link

openapi-pipeline-app bot commented Apr 25, 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 Apr 25, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
Compared specs (v0.10.8) new version base version
deviceregistry.json 2023-11-01-preview(3ffc7e9) 2023-11-01-preview(main)
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2023-11 package-preview-2023-11(3ffc7e9) package-preview-2023-11(main)

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
⚠️ 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
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json#L386
️️✔️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 Apr 25, 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 469c888. 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 succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 469c888. 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-resourcemanager-deviceregistry [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-deviceregistry-1.0.0-beta.1.jar
    • azure-resourcemanager-deviceregistry-1.0.0-beta.1-sources.jar
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from 469c888. 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.
    cmderr	[automation_init.sh]  notice
    cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
    cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
    cmderr	[automation_init.sh] npm notice Run `npm install -g npm@10.7.0` to update!
    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-py3-none-any.whl
    • azure-mgmt-deviceregistry-1.0.0b1.zip
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Apr 25, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/deviceregistry/armdeviceregistry There is no API change compared with the previous version
Java azure-resourcemanager-deviceregistry https://apiview.dev/Assemblies/Review/90da387f53324bba89095f644611247c?revisionId=372b456434324af1b3cd3fe4b565f5ff
Swagger Microsoft.DeviceRegistry https://apiview.dev/Assemblies/Review/a84f09ee6eb74e6db3594048924a2f07?revisionId=b2b2c51a58264a4481c29dc6136dba34
TypeSpec DeviceRegistry.Management https://apiview.dev/Assemblies/Review/8c8020c228c948c5bb66512e800753e8?revisionId=20a5ead98c884bf7817c3659f2702e21

@XiaofeiCao
Copy link
Contributor

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

Copy link
Contributor

@XiaofeiCao XiaofeiCao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from generated Java SDK:
azure-sdk/azure-sdk-for-java#10305

@XiaofeiCao
Copy link
Contributor

Some of Go's generated example files seem to be affected.
azure-sdk/azure-sdk-for-go#9711

@tadelesh @raych1 Would you help take a look?

@madhura-np madhura-np added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 8, 2024
@raych1
Copy link
Member

raych1 commented May 10, 2024

Some of Go's generated example files seem to be affected. azure-sdk/azure-sdk-for-go#9711

@tadelesh @raych1 Would you help take a look?

@XiaofeiCao , the generated SDK PR doesn't include the sample files by default. So the sample changes to Go can be skipped.

@XiaofeiCao XiaofeiCao merged commit ac882a9 into main May 10, 2024
31 of 32 checks passed
@XiaofeiCao XiaofeiCao deleted the davidemontanari/deviceregistry-fix-examples branch May 10, 2024 03:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] device registry tsp definition, wrong operationId in tsp example files
5 participants