[Hub Generated] Review request for Microsoft.KeyVault to add version stable/7.4 #22881
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, @rahulalapati43 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.10.4)] | new version | base version |
|---|---|---|
| settings.json | 7.4(3c17c74) | 7.4(main) |
| Rule | Message |
|---|---|
|
The new version is missing a property found in the old version. Was 'value' renamed or removed? New: Microsoft.KeyVault/stable/7.4/settings.json#L190:7 Old: Microsoft.KeyVault/stable/7.4/settings.json#L190:7 |
|
The new version has a new read-only property 'settings' in response that was not found in the old version. New: Microsoft.KeyVault/stable/7.4/settings.json#L190:7 Old: Microsoft.KeyVault/stable/7.4/settings.json#L190:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-7.4 | package-7.4(3c17c74) | package-7.4(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Microsoft.KeyVault/stable/7.4/settings.json#L6 |
|
| A patch operation should consume 'application/merge-patch+json' content type. Location: Microsoft.KeyVault/stable/7.4/settings.json#L31 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.KeyVault/stable/7.4/settings.json#L35 |
|
| Parameter name 'setting-name' should be camel case. Location: Microsoft.KeyVault/stable/7.4/settings.json#L39 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.KeyVault/stable/7.4/settings.json#L39 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.KeyVault/stable/7.4/settings.json#L63 |
|
The error property in the error response schema should be required.Location: Microsoft.KeyVault/stable/7.4/settings.json#L65 |
|
Error schema should define code and message properties as required.Location: Microsoft.KeyVault/stable/7.4/settings.json#L65 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.KeyVault/stable/7.4/settings.json#L80 |
|
| Parameter name 'setting-name' should be camel case. Location: Microsoft.KeyVault/stable/7.4/settings.json#L84 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.KeyVault/stable/7.4/settings.json#L84 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.KeyVault/stable/7.4/settings.json#L98 |
|
The error property in the error response schema should be required.Location: Microsoft.KeyVault/stable/7.4/settings.json#L100 |
|
Error schema should define code and message properties as required.Location: Microsoft.KeyVault/stable/7.4/settings.json#L100 |
|
| Based on the response model schema, operation 'GetSettings' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.KeyVault/stable/7.4/settings.json#L113 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.KeyVault/stable/7.4/settings.json#L113 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.KeyVault/stable/7.4/settings.json#L117 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.KeyVault/stable/7.4/settings.json#L132 |
|
The error property in the error response schema should be required.Location: Microsoft.KeyVault/stable/7.4/settings.json#L134 |
|
Error schema should define code and message properties as required.Location: Microsoft.KeyVault/stable/7.4/settings.json#L134 |
|
| Schema should have a description or title. Location: Microsoft.KeyVault/stable/7.4/settings.json#L161 |
️️✔️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]
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
ghost
added
the
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @rahulalapati43, 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. |
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
|
The breaking change is to fix a property name change, which was missed during the 7.4 stable release. |
jlichwa
approved these changes
Mar 2, 2023
heaths
approved these changes
Mar 2, 2023
heaths
added
the
Approved-BreakingChange
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
…stable/7.4 (Azure#22881) * Corrected property name in SettingsListResult from value to settings. * Corrected te property name in the examples. --------- Co-authored-by: Rahul Alapati <[email protected]>
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links