Microsoft.BareMetalInfrastructure: add stable API version 2021-08-09 #15680
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, @lagalbra 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. [email protected] |
|
[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. |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @lagalbra your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The schema 'AzureBareMetalInstancesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L251 |
|
The schema 'AzureBareMetalInstance' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L267 |
|
The schema 'AzureBareMetalInstanceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L287 |
|
The schema 'HardwareProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L362 |
|
The schema 'Disk' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L434 |
|
The schema 'StorageProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L454 |
|
The schema 'OSProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L471 |
|
The schema 'NetworkProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L494 |
|
The schema 'IpAddress' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L511 |
|
The schema 'Result' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L553 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L588 |
|
The schema 'ErrorDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L597 |
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L545 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 6 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.0)
- current:stable/2021-08-09/baremetalinfrastructure.json compared with base:preview/2020-08-06-preview/baremetalinfrastructure.json
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/start' removed or restructured? Old: Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json#L37:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/restart' removed or restructured? Old: Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json#L83:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/shutdown' removed or restructured? Old: Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json#L129:5 |
|
The operation id has been changed from 'AzureBareMetalInstances_List' to 'AzureBareMetalInstances_ListByResourceGroup'. This will impact generated code. New: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L78:7 Old: Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json#L216:7 |
|
The new version is missing a property found in the old version. Was 'origin' renamed or removed? New: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L564:7 Old: Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json#L741:7 |
|
The new version is missing an operation that was found in the old version. Was operationId 'AzureBareMetalInstances_Delete' removed or restructured? New: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L159:5 Old: Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json#L296:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
@lagalbra Now the default branch is main, and I have updated the PR to target main |
|
@ArcturusZhang Is there anything else you need from me before reviewing this PR? |
pilor
reviewed
Aug 21, 2021
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}": { |
There was a problem hiding this comment.
If this is a tracked resource how is it created without a PUT request and how are they deleted without the DELETE request that was in 2021-08-06-preview?
There was a problem hiding this comment.
I'm sure this has probably come up before. May want to boilerplate call this info out in any future reviews
There was a problem hiding this comment.
Our service's flow is a little unique, as our resources' creation is negotiated manually via contract rather than just calling a PUT API for any given resource. We are looking at enabling the regular ARM PUT flow instead, but would add it in a future GA version as it is not reliable yet.
There was a problem hiding this comment.
Similarly, DELETE is not supported because the contract's terms are for set durations of time, and thus the customer cannot choose (and call an API) when to delete resources outside of that.
There was a problem hiding this comment.
These are marked as tracked resources in your RP manifest. How does the ARM cache (and Azure Resource Graph, etc...) stay up to date with their state? If you don't support a DELETE what happens when a user tries to remove a resource group that contains one of these (the RG deletion would never succeed since ARM can't delete the resource).
There was a problem hiding this comment.
We have internal logic to rehydrate the ARM cache when resources are deleted in the backend.
Correct, since we don't support delete, we also do not support deletion of a resource group that contains this resource type.
We have discussed an exception for supporting PUT/DELETE, noted in our tracking work item here: https://dev.azure.com/msazure/One/_workitems/edit/9821575
There was a problem hiding this comment.
Please include this information up front in future swagger PRs. It'll make things a lot faster
pilor
added
the
ARMChangesRequested
|
In future PRs please ensure you have followed the below instruction from the PR description. "To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits." |
pilor
added
ARMSignedOff
specification/baremetalinfrastructure/resource-manager/readme.go.md
Outdated
Show resolved
Hide resolved
|
@ArcturusZhang I see that some Required merge checks failed:
|
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@msftclas ping to evaluate license/cla |
1 similar comment
|
@msftclas ping to evaluate license/cla |
|
close and reopen to resolve the license/cla status check |
|
Reviewier @changlong-liu here are the reasons behind each "cross-version breaking change":
|
changlong-liu
approved these changes
Sep 9, 2021
|
approved breaking change since it's against a preview api-version for one year. (2020-08-06-preview is merged at september 11, 2020) |
This was referenced Sep 9, 2021
iscai-msft
added a commit
to iscai-msft/azure-rest-api-specs
that referenced
this pull request
Sep 10, 2021
…into add_endpoint * 'main' of https://github.com/Azure/azure-rest-api-specs: (5079 commits) Add Microsoft.ExtendedLocation [CustomLocation] 2021-08-15 stable API Version (Azure#15967) Updated SKU property to be read only (Azure#15965) Add Microsoft.Communication.UserDisconnected Event (Azure#15870) Add collection APIs (Azure#15221) [Cognitive Services - Personalizer] v1.1-preview.2 (Azure#15699) Adding default error response & updating basePath (Azure#15784) Update readme and readme.python (Azure#15973) add synapse batch tag package-composite-v1 (Azure#15974) Microsoft.BareMetalInfrastructure: add stable API version 2021-08-09 (Azure#15680) change readme.go.md template to track 2 (Azure#15972) [CosmosDB] Adding apiVersion 2021-07-01-preview (Azure#14817) Merge Dev-containerservice-microsoft.containerservice-2021-08-01 branch to main (Azure#15954) DiskRP swagger for 2021-04-01 (Azure#15665) Use IncidentSeverity in IncidentInfo (Azure#15762) Add stable API version "2021-09-01" (Azure#15897) add-purview-typescript-file (Azure#15948) Swagger Completeness for Microsoft.Authorization (Azure#15253) [Hub Generated] Review request for Microsoft.Aadiam to add version preview/2020-03-01-preview and stable/2020-03-01 (Azure#15861) Add swagger for missing CheckPolicyRestrictions API version (Azure#15888) Add Red Hat OpenShift 2021-09-01-preview (Azure#15616) ...
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:
General GA date of September 30, 2021
ASAP, as we plan to meet a general GA date of September 30, and our CLIs/SDKs must be generated from this stable folder.
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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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.