RecoveryServices @ 2023-06-01: adding CertificateCreateOptions
#26680
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
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| registeredidentities.json | 2023-06-01(456526f) | 2023-06-01(main) |
| Rule | Message |
|---|---|
|
The new version has a new optional property 'certificateCreateOptions' that was not found in the old version. New: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L126:7 Old: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L126:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-06 | package-2023-06(456526f) | package-2023-06(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L130 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName} is missing. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L20 |
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections is missing. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L20 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}' Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L21 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L21 |
|
The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L21 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L21 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'VaultCertificates_Create' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L22 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L22 |
|
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L64 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L64 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}' Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L80 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L80 |
|
The resource name parameter 'identityName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L80 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L80 |
|
Synchronous delete operations must have responses with 200, 204 and default return codes. They also must have no other response codes. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L81 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L108 |
|
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L108 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L108 |
|
The nested resource 'VaultCertificateResponse' does not have list operation, please add it. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L309 |
|
The parameter 'SubscriptionId' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L336 |
|
The parameter 'ApiVersion' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L359 |
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L6 |
|
| The response of operation:'VaultCertificates_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L22 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L34 |
|
| Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L34 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L34 |
|
| Use the latest version v5 of types.json. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L36 |
|
| Use the latest version v5 of types.json. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L39 |
|
| Use the latest version v5 of types.json. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L42 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.RecoveryServices/stable/2023-06-01/registeredidentities.json#L87 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
microsoft-github-policy-service
bot
added
the
customer-reported
|
Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon. |
AzureRestAPISpecReview
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
This was referenced Nov 13, 2023
These exist in the API but aren't exposed, meaning that consumers currently have to append these values themselves https://github.com/hashicorp/terraform-provider-azurerm/blob/bf4b436d9bd36ee253c4947f4812846528a47345/internal/services/recoveryservices/azuresdkhacks/model_certificaterequest.go#L12-L19
tombuildsstuff
force-pushed
the
recoveryservicessiterecovery/missing-certificate-create-options
branch
from
4daad23 to
456526f
Compare
AzureRestAPISpecReview
added
the
ReadyForApiTest
tombuildsstuff
added a commit
to hashicorp/pandora
that referenced
this pull request
Nov 13, 2023
…rest-api-specs#26680 This is currently hand-defined in the Provider https://github.com/hashicorp/terraform-provider-azurerm/blob/bf4b436d9bd36ee253c4947f4812846528a47345/internal/services/recoveryservices/azuresdkhacks/model_certificaterequest.go#L12-L19 and should instead be added to the API Definition
tombuildsstuff
added a commit
to tombuildsstuff/openapi-diff
that referenced
this pull request
Nov 15, 2023
…s as a breaking change Breaking changes happen when the Request payload between one version of the API and another version of the API are incompatible - meaning that the minimum viable payload from the old API version does not work with the new API version. In the event of a new Optional field being added to the Request (or Response) payload the minimum viable request payload remains valid, therefore provided the field is correctly flagged as Required/Optional, we can lean on that to determine whether a breaking change is actually a breaking change. This fixes an issue seen in Azure/azure-rest-api-specs#26680 and Azure/azure-rest-api-specs#22407 and Azure/azure-rest-api-specs#25080 where the API Definition doesn't correctly document all of the possible fields within the Request/Response payloads. Since this is going a conditional check, this commit changes this from an Error to a Warning - as whilst there are situations where this can be a breaking change; this requires understanding the change.
konrad-jamrozik
added
VersioningReviewRequired
|
Hi @tombuildsstuff would you please extend this change to all newer versions as well. |
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 (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
recoveryservices@2022-10-01:VaultCertificates_Createlack difination ofcertificateCreateOptions, the resource lack ofGETandDELETE#22572Due 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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.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 ApiViewcomment 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
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.