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.

Sign up for GitHub

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

Jump to bottom

Update ManagedIdentity.json #1184

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update ManagedIdentity.json #1184

wants to merge 1 commit into from

Conversation

PhoenixHe-NV
Copy link

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

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. 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
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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
    • No, no need to refresh for updates in this PR

Contribution checklist:

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

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service

  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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-kebab-tih-test
Copy link

openapi-kebab-tih-test bot commented Apr 26, 2021 •
edited
Loading

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities' removed or restructured?
Old: Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json#L139:5
️❌LintDiff: 1 Errors, 1 Warnings failed [Detail]
The following errors/warnings are introduced by current PR:
Rule Message
❌ R4016 - TopLevelResourcesListByResourceGroup The top-level resource 'Identity' does not have list by resource group operation, please add it.
Location: Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json#L315
⚠️ R3027 - TrackedResourceListByResourceGroup The tracked resource, 'Identity', must have a list by resource group operation.(This rule does not apply for tenant level resources.)
Location: Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json#L315


The following errors/warnings exist before current PR submission:

Rule Message
❌ R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ManagedIdentity/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json#L70
⚠️ R3017 - GuidUsage Guid used in model definition 'SystemAssignedIdentityProperties' for property 'tenantId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
Location: Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json#L411
⚠️ R3017 - GuidUsage Guid used in model definition 'UserAssignedIdentityProperties' for property 'tenantId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
Location: Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json#L441
⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: MsiOperationsList
Location: Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json#L74
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/msi/resource-manager/readme.md
json: stable/2018-11-30/examples/IdentityListByResourceGroup.json
️️✔️ModelValidation succeeded [Detail] [Expand] 
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-kebab-tih-test
Copy link

openapi-kebab-tih-test bot commented Apr 26, 2021 •
edited
Loading

Swagger Generation Artifacts

️🔄[Staging] ApiDocPreview inProgress [Detail]
️❌[Staging] UpdateTracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - msi/mgmt/2018-11-30/msi - Approved - v53.4.0
+	- Function `UserAssignedIdentitiesClient.ListByResourceGroupComplete` has been removed
+	- Function `UserAssignedIdentitiesClient.ListByResourceGroupPreparer` has been removed
+	- Function `UserAssignedIdentitiesClient.ListByResourceGroupResponder` has been removed
+	- Function `UserAssignedIdentitiesClient.ListByResourceGroupSender` has been removed
+	- Function `UserAssignedIdentitiesClient.ListByResourceGroup` has been removed
️✔️azure-sdk-for-go - preview/msi/mgmt/2015-08-31-preview/msi - Approved - v53.4.0
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from bb14326. SDK Automation 14.0.0 
    command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️msi/mgmt/2018-11-30/msi [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `UserAssignedIdentitiesClient.ListByResourceGroupComplete` has been removed
info	[Changelog] - Function `UserAssignedIdentitiesClient.ListByResourceGroupPreparer` has been removed
info	[Changelog] - Function `UserAssignedIdentitiesClient.ListByResourceGroupSender` has been removed
info	[Changelog] - Function `UserAssignedIdentitiesClient.ListByResourceGroup` has been removed
info	[Changelog] - Function `UserAssignedIdentitiesClient.ListByResourceGroupResponder` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog]
info	[Changelog] Total 5 breaking change(s), 0 additive change(s).
info	[Changelog]
  • ️✔️preview/msi/mgmt/2015-08-31-preview/msi [View full logs]  [Preview SDK Changes] 
    info	[Changelog] No exported changes
Posted by Swagger Pipeline | How to fix these errors?

This was referenced Apr 26, 2021
Draft
Draft
@PhoenixHe-NV
Copy link
Author

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@PhoenixHe-NV
Copy link
Author

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@PhoenixHe-NV
Copy link
Author

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Approved-SdkBreakingChange-Go BreakingChangeReviewRequired CI-BreakingChange-Go
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@PhoenixHe-NV