-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Additional TieringPolicy and ProtectedItemExtendedInfo details for Microsoft.RecoveryServices version 2021-12-01 #17517
Conversation
Hi, @anjorsh 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. |
Swagger Validation Report
|
Rule | Message |
---|---|
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig' Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L21 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection' Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L164 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus' Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L209 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures' Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L254 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}' Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L299 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionIntents' Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L460 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries' Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L517 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'BackupResourceStorageConfigsNonCRR_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L22 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'BackupResourceStorageConfigsNonCRR_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L65 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectionIntent_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L300 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectionIntent_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L351 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'BackupResourceVaultConfigs_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L609 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'BackupResourceVaultConfigs_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L652 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'BackupResourceVaultConfigs_Put' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L704 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'BackupResourceEncryptionConfigs_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L758 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnection_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L852 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnection_Put' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L902 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectedItems_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L1298 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectedItems_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L1373 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectedItemOperationResults_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L1521 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'RecoveryPoints_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L1677 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectionPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L1907 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectionPolicies_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L1960 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectionPolicyOperationResults_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L2093 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'JobDetails_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L2221 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'BackupEngines_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L2834 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectionContainers_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L3022 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectionContainers_Register' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L3079 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ProtectionContainerOperationResults_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L3352 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ResourceGuardProxy_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2021-12-01/bms.json#L4313 |
️️✔️
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
|
Hi, @anjorsh your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
NewApiVersionRequired reason: |
Hi @anjorsh, Your PR has some issues. Please fix the CI sequentially by following the order of
|
These changes for version 2021-12-01 were missed in an earlier PR for introducing this version: This is not a breaking change since there are currently no users for this API version. |
"tieringPolicy": { | ||
"description": "Tiering policy to automatically move RPs to another tier\r\nKey is Target Tier, defined in RecoveryPointTierType enum.\r\nTiering policy specifies the criteria to move RP to the target tier.", | ||
"type": "object", | ||
"additionalProperties": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this modeled as additionalProperties? ARM doesn't allow additionalProperties unless the members are unknown, dynamic or user defined. Ref: https://armwiki.azurewebsites.net/api_contracts/guidelines/openapi.html#oapi032-only-use-additionalproperties-when-the-object-properties-are-dynamic-unknown-or-user-defined #Closed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The tieringPolicy field is a dictionary. As per the OpenAPI specification, dictionaries need to be defined with the additionalProperties keyword.
Ref: https://swagger.io/docs/specification/data-models/dictionaries/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the size of the dictionary dynamic? Meaning can the user only specify one element out of all the possible elements?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes
@anjorsh, please add the WaitForARMFeedback or WaitForARMRevisit label when you are ready for revisit: that will notify the current oncall that your PR is ready for revisit. |
Hi @anjorsh, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
@anjorsh , please fix CI check failures. |
…crosoft.RecoveryServices version 2021-12-01 (Azure#17517) * Additional TieringPolicy and ProtectedItemExtendedInfo details for version 2021-12-01 * Prettier Fix * Fixing ModelValidation * Fixing LintDiff * Added more details in description as per review comments * Updated description for oldestRecoveryPoint * Fixing Prettier * Test Fix for SDK generation * SemanticValidation Fixes
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:
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.