Dev azurestackhci microsoft.azure stack hci 2022 10 01 #20924
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, @aditya-rs 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] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| arcSettings.json | 2022-10-01(cc9e791) | 2022-09-01(main) |
| arcSettings.json | 2022-10-01(cc9e791) | 2021-01-01-preview(main) |
| clusters.json | 2022-10-01(cc9e791) | 2022-09-01(main) |
| clusters.json | 2022-10-01(cc9e791) | 2021-01-01-preview(main) |
| extensions.json | 2022-10-01(cc9e791) | 2022-09-01(main) |
| extensions.json | 2022-10-01(cc9e791) | 2021-01-01-preview(main) |
| operations.json | 2022-10-01(cc9e791) | 2022-09-01(main) |
| operations.json | 2022-10-01(cc9e791) | 2021-01-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version adds a response code '202'. New: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L286:11 |
|
| The new version adds a response code '200'. New: Microsoft.AzureStackHCI/stable/2022-10-01/extensions.json#L221:11 |
|
| The new version adds a response code '202'. New: Microsoft.AzureStackHCI/stable/2022-10-01/extensions.json#L227:11 |
|
| The read only property has changed from 'true' to 'false'. New: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L457:9 Old: Microsoft.AzureStackHCI/preview/2021-01-01-preview/arcSettings.json#L280:9 |
|
| The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L257:7 Old: Microsoft.AzureStackHCI/preview/2021-01-01-preview/clusters.json#L257:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 8 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-10 | package-2022-10(cc9e791) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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.AzureStackHCI/stable/2022-10-01/skus.json#L160 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'UpdateSummariesModel'. Consider using the plural form of 'UpdateSummaries' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/stable/2022-10-01/updateSummaries.json#L39 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'UpdateSummariesModel'. Consider using the plural form of 'UpdateSummaries' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/stable/2022-10-01/updateSummaries.json#L81 |
||
| OperationId should contain the verb: 'apply' in:'Updates_Post'. Consider updating the operationId Location: Microsoft.AzureStackHCI/stable/2022-10-01/updates.json#L39 |
||
| The child tracked resource, 'updateRuns' with immediate parent 'Update', must have a list by immediate parent operation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/updateRuns.json#L147 |
||
| The child tracked resource, 'updates' with immediate parent 'Cluster', must have a list by immediate parent operation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/updates.json#L208 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List available updates Location: Microsoft.AzureStackHCI/stable/2022-10-01/updates.json#L115 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Update summaries under cluster resource Location: Microsoft.AzureStackHCI/stable/2022-10-01/updateSummaries.json#L111 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Missing identifier id in array item property Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L503 |
|
Missing identifier id in array item property Location: Microsoft.AzureStackHCI/stable/2022-10-01/extensions.json#L373 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L887 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L913 |
|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.AzureStackHCI/stable/2022-10-01/operations.json#L38 |
|
| OperationId should contain the verb: 'createarcidentity' in:'ArcSettings_CreateIdentity'. Consider updating the operationId Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L316 |
|
| OperationId should contain the verb: 'createclusteridentity' in:'Clusters_CreateIdentity'. Consider updating the operationId Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L359 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L563 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoUpgradeMinorVersion Location: Microsoft.AzureStackHCI/stable/2022-10-01/extensions.json#L461 |
|
| 'PasswordCredential' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L570 |
|
| 'secretText' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L573 |
|
| 'keyId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L576 |
|
| 'startDateTime' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L579 |
|
| 'endDateTime' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L583 |
|
| 'ArcIdentityResponseProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L602 |
|
| 'arcApplicationClientId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L605 |
|
| 'arcApplicationTenantId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L608 |
|
| 'arcServicePrincipalObjectId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L611 |
|
| 'arcApplicationObjectId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/arcSettings.json#L614 |
|
| 'RawCertificateData' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L872 |
|
| 'certificates' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L875 |
|
| 'UploadCertificateRequest' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L884 |
|
| 'SoftwareAssuranceChangeRequestProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L893 |
|
| 'softwareAssuranceIntent' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L896 |
|
| 'SoftwareAssuranceChangeRequest' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L910 |
|
| 'ClusterIdentityResponseProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L930 |
|
| 'aadClientId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L933 |
|
| 'aadTenantId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L936 |
|
| 'aadServicePrincipalObjectId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L939 |
|
| 'aadApplicationObjectId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureStackHCI/stable/2022-10-01/clusters.json#L942 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.AzureStackHCI' for api version '2022-10-01'. The supported api-versions are '2020-03-01-preview, 2020-10-01, 2020-11-01-preview, 2021-01-01-preview, 2021-07-01-preview, 2021-09-01-preview, 2021-09-01, 2022-01-01, 2022-03-01, 2022-05-01, 2022-08-01-preview, 2022-09-01'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️⚠️~[Staging] TrafficValidation: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 5 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/cc9e79188a0d40a064cc03fa2473311173dec797/specification/azurestackhci/resource-manager/readme.md#tag-package-2022-10">azurestackhci/resource-manager/readme.md#package-2022-10
| Rule | Message |
|---|---|
| "readme":"azurestackhci/resource-manager/readme.md", "tag":"package-2022-10", "details":"Schema 'ArcSetting' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from ArcSetting" |
|
| "readme":"azurestackhci/resource-manager/readme.md", "tag":"package-2022-10", "details":"Schema 'Cluster' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from Cluster" |
|
| "readme":"azurestackhci/resource-manager/readme.md", "tag":"package-2022-10", "details":"Schema 'Extension' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from Extension" |
|
| "readme":"azurestackhci/resource-manager/readme.md", "tag":"package-2022-10", "details":"Schema 'Update' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from Update" |
|
| "readme":"azurestackhci/resource-manager/readme.md", "tag":"package-2022-10", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Sep 29, 2022
AzureRestAPISpecReview
added
ARMReview
ReadyForApiTest
|
Hi, @aditya-rs your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
|
|
This was referenced Sep 29, 2022
mentat9
reviewed
Sep 29, 2022
...ication/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-10-01/offers.json
Outdated
Show resolved
Hide resolved
mentat9
reviewed
Sep 29, 2022
...ication/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-10-01/offers.json
Show resolved
Hide resolved
mentat9
reviewed
Sep 29, 2022
| "type": "string", | ||
| "readOnly": true | ||
| }, | ||
| "publisherId": { |
There was a problem hiding this comment.
Description already added
There was a problem hiding this comment.
But even the description is ambiguous. If this isn't an ARM resource Id, then what is it? A guid? A user-selected name, something else? It's helpful for users of your APIs to have more than "publisher Id" to go on.
There was a problem hiding this comment.
PublisherId is one of the attributes to determine marketplace image offer. A marketplace image in azure has publisher, offer, sku and version attributes which uniquely identify a given image offer.
We tried to align with existing compute RP marketplace APIs, so we followed similar naming convention in our RP as well.
agrbhuvnesh
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
mentat9
reviewed
Sep 30, 2022
...zurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-10-01/updateSummaries.json
Show resolved
Hide resolved
mentat9
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
agrbhuvnesh
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Signing off with comments to unblock. Please address remaining comments before merging this PR These two are particularly important: |
mentat9
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
…https://github.com/aditya-rs/azure-rest-api-specs into dev-azurestackhci-Microsoft.AzureStackHCI-2022-10-01
tianxchen-ms
approved these changes
Oct 2, 2022
This was referenced Oct 2, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Oct 2, 2022
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.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
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.
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.