Add x-ms-identifiers to solutions/resource-manager. #17782
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @vukelich Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Since operation 'ListOperations' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L42 |
|
| The operation 'Applications_Update' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L217 |
|
| Based on the response model schema, operation 'jitRequests_ListBySubscription' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L816 |
|
| Based on the response model schema, operation 'jitRequests_ListByResourceGroup' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L852 |
|
| Sku Model definition 'Sku' is not valid. A Sku model must have 'name' property. It can also have 'tier', 'size', 'family', 'capacity' as optional properties. Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L1359 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L1185 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: jitAccessEnabled Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L1797 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or update managed application Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L223 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List managed application definitions Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L512 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Lists applications Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L593 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or update jit request Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L672 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or update jit request Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L731 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List jit requests Location: Microsoft.Solutions/stable/2021-07-01/managedapplications.json#L858 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=277130&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
️✔️azure-sdk-for-go - resources/mgmt/2021-07-01/managedapplications - v61.4.0️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-managedapplication - first release❌azure-sdk-for-go-track2 - armmanagedapplications - 0.3.0+ Function `ErrorDetail.MarshalJSON` has been removed
+ Struct `ApplicationPropertiesPatchable` has been removed
+ Struct `ErrorAdditionalInfo` has been removed
+ Struct `ErrorDetail` has been removed
- Type of `ApplicationPropertiesPatchable.Outputs` has been changed from `map[string]interface{}` to `interface{}`
- Type of `ApplicationPropertiesPatchable.Parameters` has been changed from `map[string]interface{}` to `interface{}`️⚠️ azure-sdk-for-python-track2 warning [Detail]
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. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.5.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.0> cmderr [automation_generate.sh] npm notice Run `npm install -g npm@8.5.0` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-managedapplication [View full logs] [Release SDK Changes]info [Changelog] - Initial Release
️⚠️ azure-sdk-for-java warning [Detail]
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 cmderr [generate.py] 2022-02-11 08:40:39 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-solutions" cmderr [generate.py] 2022-02-11 08:40:39 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1" cmderr [generate.py] 2022-02-11 08:40:39 INFO autorest --version=3.6.6 --use=@autorest/java@4.0.47 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/solutions/azure-resourcemanager-solutions --java.namespace=com.azure.resourcemanager.solutions --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/solutions/resource-manager/readme.md cmderr [generate.py] 2022-02-11 08:41:07 INFO [CI][Success] Write to ci.yml cmderr [generate.py] 2022-02-11 08:41:07 INFO [POM][Process] dealing with pom.xml cmderr [generate.py] 2022-02-11 08:41:07 INFO [POM][Skip] pom already has module azure-resourcemanager-solutions cmderr [generate.py] 2022-02-11 08:41:07 INFO [POM][Success] Write to pom.xml cmderr [generate.py] 2022-02-11 08:41:07 INFO [POM][Process] dealing with root pom cmderr [generate.py] 2022-02-11 08:41:07 INFO [POM][Success] Write to root pom
️✔️azure-resourcemanager-solutions [View full logs] [Release SDK Changes]- pom.xml
- azure-resourcemanager-solutions-1.0.0-beta.1-sources.jar
- azure-resourcemanager-solutions-1.0.0-beta.1.jar
cmderr [Inst] 2022-02-11 08:42:50 DEBUG Got artifact_id: azure-resourcemanager-solutions cmderr [Inst] 2022-02-11 08:42:50 DEBUG Got artifact: pom.xml cmderr [Inst] 2022-02-11 08:42:50 DEBUG Got artifact: azure-resourcemanager-solutions-1.0.0-beta.1-sources.jar cmderr [Inst] 2022-02-11 08:42:50 DEBUG Got artifact: azure-resourcemanager-solutions-1.0.0-beta.1.jar cmderr [Inst] 2022-02-11 08:42:50 DEBUG Match jar package: azure-resourcemanager-solutions-1.0.0-beta.1.jar cmderr [Inst] 2022-02-11 08:42:50 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/17782/azure-sdk-for-java/azure-resourcemanager-solutions/azure-resourcemanager-solutions-1.0.0-beta.1.jar\" -o azure-resourcemanager-solutions-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-solutions -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-solutions-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true ```"}
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
command sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️resources/mgmt/2021-07-01/managedapplications [View full logs] [Release SDK Changes]info [Changelog] This is a new package info [Changelog]
️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
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
️✔️armmanagedapplications [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Type of `ApplicationDefinitionProperties.CreateUIDefinition` has been changed from `map[string]interface{}` to `interface{}` info [Changelog] - Type of `ApplicationDefinitionProperties.MainTemplate` has been changed from `map[string]interface{}` to `interface{}` info [Changelog] - Type of `ApplicationProperties.Outputs` has been changed from `map[string]interface{}` to `interface{}` info [Changelog] - Type of `ApplicationProperties.Parameters` has been changed from `map[string]interface{}` to `interface{}` info [Changelog] - Function `ErrorDetail.MarshalJSON` has been removed info [Changelog] - Struct `ApplicationPropertiesPatchable` has been removed info [Changelog] - Struct `ErrorAdditionalInfo` has been removed info [Changelog] - Struct `ErrorDetail` has been removed info [Changelog] - Struct `ErrorResponse` has been removed info [Changelog] info [Changelog] Total 11 breaking change(s), 0 additive change(s).
️⚠️ azure-sdk-for-js warning [Detail]
command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json cmderr [automation_init.sh] deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist cmderr [automation_init.sh] deprecated uuid@3.4.0: Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details. cmderr [automation_init.sh] deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js cmderr [automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file. cmderr [automation_init.sh] @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself. 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 warn No file changes detected after generation warn No package detected after generation
This was referenced Feb 10, 2022
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
dw511214992
approved these changes
Feb 11, 2022
This was referenced Feb 11, 2022
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
Mar 7, 2022
Co-authored-by: Steven Vukelich <svukel@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
EXPLANATION OF THIS CHANGE
APIs will need to start indicating item uniqueness in
arrays. By default, uniqueness is thestringproperty called"id"of items in anarray. When that property does not exist, thex-ms-identifiersextension 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.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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.