Adding put and delete BMI operations to baremetalinfrastructure.json spec#24059
Adding put and delete BMI operations to baremetalinfrastructure.json spec#24059
Conversation
|
Hi, @8Gitbrix 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| baremetalinfrastructure.json | 2023-04-06(07d4d97) | 2023-04-06(main) |
| Rule | Message |
|---|---|
1039 - AddedOperation |
The new version is adding an operation that was not found in the old version. New: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L201:7 |
1039 - AddedOperation |
The new version is adding an operation that was not found in the old version. New: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L240:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 7 Errors, 1 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-04-06 | package-2023-04-06(07d4d97) | package-2023-04-06(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
PutGetPatchResponseSchema |
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L159 |
RPC-Put-V1-12 |
DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L227 |
RPC-Delete-V1-01 |
ValidResponseCodeRequired |
There is no declared valid status code. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L227 |
|
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L228 |
|
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L275 |
RPC-Put-V1-11 |
ValidResponseCodeRequired |
There is no declared valid status code. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L275 |
|
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L276 |
|
| 'PUT' operation 'AzureBareMetalInstances_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L244 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L144 |
ResourceNameRestriction |
The resource name parameter 'azureBareMetalInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L159 |
MissingTypeObject |
The schema 'AzureBareMetalInstancesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L603 |
MissingTypeObject |
The schema 'AzureBareMetalInstance' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L619 |
TrackedResourcesMustHavePut |
The tracked resource AzureBareMetalInstance does not have a corresponding put operation. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L619 |
MissingTypeObject |
The schema 'AzureBareMetalInstanceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L639 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L693 |
MissingTypeObject |
The schema 'HardwareProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L714 |
MissingTypeObject |
The schema 'Disk' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L786 |
MissingTypeObject |
The schema 'StorageProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L806 |
MissingTypeObject |
The schema 'OSProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L826 |
MissingTypeObject |
The schema 'NetworkProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L849 |
MissingTypeObject |
The schema 'IpAddress' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L869 |
MissingTypeObject |
The schema 'Result' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L914 |
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json#L906 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
|
As a note, our RP does not support PUT or DELETE operations. However, as a requirement for GA, we need to return a response for them. The ARM team originally gave us the greenlight for only returning a "Not supported" code with a message stating the official routes needed to perform it. Which is why we do not have any 2xx responses listed. Second, this is not a breaking change. This api version, 2023-04-06, received an exception very recently when it was created for not adding PUT/DELETE operations. This PR simply adds a formal "Not supported" response. No actual functionality with this operation has changed. |
|
Hi @8Gitbrix, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
The automation detected this Pull Request introduces breaking changes to an existing API version and hence it added the |
|
@konrad-jamrozik can we approve this breaking change? |
Can you link me to the greenlight from the ARM team, so I can verify?
To which of the failing checks of the breaking change detector are you referring to specifically? I mean the failures listed here.
Please address my questions above. I also recommend addressing the other failures. Thx! :) |
…rastructure-2023-04-06' of https://github.com/Azure/azure-rest-api-specs into 8Gitbrix-baremetalinfrastructure-Microsoft.BareMetalInfrastructure-2023-04-06
Note: ARM signed off on the private PR here: https://github.com/Azure/azure-rest-api-specs-pr/pull/12118. |
Next Steps to MergeNext steps that must be taken to merge this PR:
|
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
7 similar comments
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @8Gitbrix. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
13 similar comments
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @8Gitbrix. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
ARM API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 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.
-[ ] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.