add x-ms-identifiers for iotsecurity by j-zhong-ms · Pull Request #19981 · Azure/azure-rest-api-specs

j-zhong-ms · 2022-07-27T15:13:13Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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
  About this Change
  APIs will need to start indicating item uniqueness in arrays. By default, uniqueness is the string property called "id" of items in an array. When that property does not exist, the x-ms-identifiers extension property must be used to specify the identifying property(s) or lack thereof. This pull request is my best guess effort to ease resource providers into the new requirement before it becomes enforced. Compliance and accuracy will need to be owned and maintained by the resource provider going forward.

See https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-identifiers.

You can also make changes after this PR is checked in. At this point, this annotation is only used by Change Analysis for change computation, so making changes afterwards shouldn’t be a breaking change.
2. 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.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [ ] SDK of .NET (need service team to ensure code readiness)
- [ ] SDK of Python
- [ ] SDK of Java
- [ ] SDK of Js
- [ ] SDK of Go
- [ ] PowerShell
- [ ] CLI
- [ ] Terraform
- [x] No refresh required for updates in this PR

Contribution checklist:

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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

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

openapi-workflow-bot · 2022-07-27T15:13:16Z

Hi, @j-zhong-ms 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-07-27T15:13:18Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.9.6)]	new version	base version
2021-02-01-preview	2021-02-01-preview(fb9eead)	2021-02-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 tags (via openapi-validator v1.13.0)	new version	base version
2021-02-01-preview	2021-02-01-preview(fb9eead)	2021-02-01-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L554
⚠️ R2004 - NonApplicationJsonType	Only 'application/json' content-type is supported by ARM. Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L243
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json#L141
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedForCustomer Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json#L319
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'DefenderSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L74
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'DefenderSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L108
⚠️ R4024 - PreviewVersionOverOneYear	The API version:2021-02-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L6
⚠️ R4024 - PreviewVersionOverOneYear	The API version:2021-02-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/devices.json#L6
⚠️ R4024 - PreviewVersionOverOneYear	The API version:2021-02-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json#L6
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or update IoT Defender settings Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json#L21

️️✔️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.

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

Validation passed for PoliCheck.

️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/fb9eead87f920da3b683b873d50d6835de515e5f/specification/iotsecurity/resource-manager/readme.md#tag-2021-02-01-preview">iotsecurity/resource-manager/readme.md#2021-02-01-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"iotsecurity/resource-manager/readme.md", "tag":"2021-02-01-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

️️✔️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).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

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

openapi-pipeline-app · 2022-07-27T15:13:18Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-go - armiotsecurity - 0.5.1

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

❌Failed [Logs]Release - Generate from 7473936. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/iotsecurity/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip package processing as generation is failed

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

❌Failed [Logs]Release - Generate from 7473936. 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
ENOENT: no such file or directory, copyfile 'azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity.gosource' -> 'sdkApiViewArtifacts/armiotsecurity.gosource'
Error: ENOENT: no such file or directory, copyfile 'azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity.gosource' -> 'sdkApiViewArtifacts/armiotsecurity.gosource'
    at Object.copyFileSync (fs.js:2062:3)
    at workflowPkgSaveApiViewArtifact (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:210:10)
    at Object.exports.workflowPkgMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:60:11)
    at async workflowHandleReadmeMd (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:172:9)
    at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
    at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:188:13)
    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18

️✔️armiotsecurity [View full logs]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
error	Fatal error: ENOENT: no such file or directory, copyfile 'azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity.gosource' -> 'sdkApiViewArtifacts/armiotsecurity.gosource'
error	The following packages are still pending:
error		armiotsecurity

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

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

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

j-zhong-ms · 2022-08-05T12:36:25Z

Hello @chunyu3 could you please review this pr? This change is not breaking. Thanks!

add x-ms-identifiers for iotsecurity

fb9eead

openapi-assignment-bot Bot assigned chunyu3 Jul 27, 2022

This was referenced Jul 27, 2022

[AutoPR armiotsecurity] add x-ms-identifiers for iotsecurity azure-sdk/azure-sdk-for-go#1866

Closed

[AutoPR Az.IoTSecurity] add x-ms-identifiers for iotsecurity azure-sdk/azure-powershell#1482

Closed

j-zhong-ms requested review from MichalHel and orkayam August 5, 2022 12:35

chunyu3 self-requested a review August 8, 2022 09:12

chunyu3 approved these changes Aug 8, 2022

View reviewed changes

chunyu3 merged commit 7473936 into Azure:main Aug 8, 2022

azure-sdk mentioned this pull request Aug 8, 2022

[ReleasePR Az.IoTSecurity] add x-ms-identifiers for iotsecurity Azure/azure-powershell#18507

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add x-ms-identifiers for iotsecurity#19981

add x-ms-identifiers for iotsecurity#19981
chunyu3 merged 1 commit into
Azure:mainfrom
j-zhong-ms:iotsecurity-annotation

j-zhong-ms commented Jul 27, 2022

Uh oh!

openapi-workflow-bot Bot commented Jul 27, 2022

Uh oh!

openapi-pipeline-app Bot commented Jul 27, 2022 •

edited

Loading

Uh oh!

openapi-pipeline-app Bot commented Jul 27, 2022 •

edited

Loading

Breaking Changes Tracking

Uh oh!

j-zhong-ms commented Aug 5, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

j-zhong-ms commented Jul 27, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot Bot commented Jul 27, 2022

Uh oh!

openapi-pipeline-app Bot commented Jul 27, 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 Jul 27, 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!

j-zhong-ms commented Aug 5, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

openapi-pipeline-app Bot commented Jul 27, 2022 •

edited

Loading

openapi-pipeline-app Bot commented Jul 27, 2022 •

edited

Loading