-
Notifications
You must be signed in to change notification settings - Fork 5k
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
Update detection description #29662
Merged
Merged
Update detection description #29662
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 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.12) | new version | base version |
---|---|---|
Face.json | v1.1-preview.1(e7d7c5a) | v1.1-preview.1(main) |
️️✔️
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 specs (v2.2.2) | new version | base version |
---|---|---|
v1.1-preview.1 | v1.1-preview.1(e7d7c5a) | v1.1-preview.1(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Face/preview/v1.1-preview.1/Face.json#L5 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L92 |
|
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: Face/preview/v1.1-preview.1/Face.json#L167 |
|
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: Face/preview/v1.1-preview.1/Face.json#L272 |
|
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: Face/preview/v1.1-preview.1/Face.json#L280 |
|
Parameter should have a description. Location: Face/preview/v1.1-preview.1/Face.json#L299 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L354 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L407 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L449 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L450 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L488 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L489 |
|
A delete operation should have a 204 response.Location: Face/preview/v1.1-preview.1/Face.json#L497 |
|
All success responses except 202 & 204 should define a response body. Location: Face/preview/v1.1-preview.1/Face.json#L498 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L525 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L526 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L587 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L643 |
|
Check for appropriate use of formData parameters. Location: Face/preview/v1.1-preview.1/Face.json#L644 |
|
Check for appropriate use of formData parameters. Location: Face/preview/v1.1-preview.1/Face.json#L647 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L682 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L683 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L721 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L722 |
|
A delete operation should have a 204 response.Location: Face/preview/v1.1-preview.1/Face.json#L730 |
|
All success responses except 202 & 204 should define a response body. Location: Face/preview/v1.1-preview.1/Face.json#L731 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L758 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L759 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L820 |
|
Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L876 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
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
|
This was referenced Jul 2, 2024
Closed
weidongxu-microsoft
approved these changes
Jul 3, 2024
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.
Data 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.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec 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 API Spec document (if applicable), and the root paths that have been updated.
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
Swagger-Suppression-Process
to get approval.
❔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
Getting help
write access
per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext 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.