-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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.
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
[Microsoft.AzureStackHCI] Add 2024-04-01 for StackHCI #29110
[Microsoft.AzureStackHCI] Add 2024-04-01 for StackHCI #29110
Conversation
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
Compared specs (v0.10.9) | new version | base version |
---|---|---|
arcSettings.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
arcSettings.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
clusters.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
clusters.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
deploymentSettings.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
deploymentSettings.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
edgeDevices.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
edgeDevices.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
extensions.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
extensions.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
hciCommon.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
offers.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
offers.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
publishers.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
publishers.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
securitySettings.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
securitySettings.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
skus.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
skus.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
updateRuns.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
updateRuns.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
updateSummaries.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
updateSummaries.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
updates.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
updates.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
operations.json | 2024-04-01(b647fd6) | 2024-01-01(main) |
operations.json | 2024-04-01(b647fd6) | 2024-02-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 19 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 19 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 199 Warnings warning [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
default | default(b647fd6) | default(main) |
package-2024-04 | package-2024-04(b647fd6) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 19 items are listed, please refer to log for more details.
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: operations/stable/2024-04-01/operations.json#L38 |
||
Use the latest version v5 of types.json. Location: operations/stable/2024-04-01/operations.json#L51 |
||
Use the latest version v5 of types.json. Location: operations/stable/2024-04-01/operations.json#L58 |
||
Use the latest version v5 of types.json. Location: operations/stable/2024-04-01/operations.json#L64 |
||
A nested resource type's List operation must include all the parent segments in its api path. Location: StackHCI/stable/2024-04-01/arcSettings.json#L37 |
RPC-Get-V1-11 | |
OperationId should contain the verb: 'createarcidentity' in:'ArcSettings_CreateIdentity'. Consider updating the operationId Location: StackHCI/stable/2024-04-01/arcSettings.json#L316 |
||
Missing identifier id in array item property Location: StackHCI/stable/2024-04-01/arcSettings.json#L607 |
||
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: StackHCI/stable/2024-04-01/arcSettings.json#L706 |
||
Schema should have a description or title. Location: StackHCI/stable/2024-04-01/arcSettings.json#L749 |
||
Schema should have a description or title. Location: StackHCI/stable/2024-04-01/arcSettings.json#L781 |
||
OperationId should contain the verb: 'createclusteridentity' in:'Clusters_CreateIdentity'. Consider updating the operationId Location: StackHCI/stable/2024-04-01/clusters.json#L359 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create cluster Identity Location: StackHCI/stable/2024-04-01/clusters.json#L410 |
||
Use the latest version v5 of managedidentity.json. Location: StackHCI/stable/2024-04-01/clusters.json#L618 |
||
Use the latest version v5 of managedidentity.json. Location: StackHCI/stable/2024-04-01/clusters.json#L641 |
||
Missing identifier id in array item property Location: StackHCI/stable/2024-04-01/clusters.json#L858 |
||
Missing identifier id in array item property Location: StackHCI/stable/2024-04-01/clusters.json#L995 |
||
Missing identifier id in array item property Location: StackHCI/stable/2024-04-01/clusters.json#L1002 |
||
Schema should have a description or title. Location: StackHCI/stable/2024-04-01/clusters.json#L1393 |
||
Schema should have a description or title. Location: StackHCI/stable/2024-04-01/clusters.json#L1405 |
️❌
Avocado: 15 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: operations/stable/2024-04-01/operations.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/clusters.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/arcSettings.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/extensions.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/offers.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/publishers.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/skus.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/updateRuns.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/updates.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/updateSummaries.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/deploymentSettings.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/edgeDevices.json |
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG |
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/securitySettings.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/triggerLogCollection is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/clusters.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/configureRemoteSupport is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: StackHCI/stable/2024-04-01/clusters.json |
️️✔️
SwaggerAPIView 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.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
PR in review in private repo: https://github.com/Azure/azure-rest-api-specs-pr/pull/17717 |
Hi @kazrael2119, that folder is owned by the other team - StackHCIVM and as I can see they haven't added typespec yet to the main repo. We ("StackHCI") are an already GA service and are not using typespec as well as of now. |
@priyjain358 I mean you only need add this file |
Done, please have a look. @kazrael2119 |
/pr RequestMerge |
* Add 2024-04-01 for StackHCI * add missing properties * add log collection job type * changes in sdk suppressions * sdk suppression changes
* Add 2024-04-01 for StackHCI * add missing properties * add log collection job type * changes in sdk suppressions * sdk suppression changes
* Add 2024-04-01 for StackHCI * add missing properties * add log collection job type * changes in sdk suppressions * sdk suppression changes
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PR
andDue diligence checklist
.Next Steps to Merge
comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.