-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Sdk release planner prod test2 #21870
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
Draft
dw511214992
wants to merge
5
commits into
main
Choose a base branch
from
sdk-release-planner-prod-test2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains hidden or 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, @dw511214992 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 tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-08-13 | package-2022-08-13(e20bd40) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
AvoidAnonymousParameter |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L197 |
|
AvoidAnonymousParameter |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L445 |
|
AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L461 |
|
AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L483 |
|
RequiredReadOnlyProperties |
Property 'collectionId' is a required property. It should not be marked as 'readonly' Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L602 |
|
RequiredReadOnlyProperties |
Property 'transactionId' is a required property. It should not be marked as 'readonly' Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L602 |
|
Security definition should have a description. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L43 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L56 |
||
Error response should contain a x-ms-error-code header. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L77 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L87 |
||
All success responses except 202 & 204 should define a response body. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L97 |
||
Error response should contain a x-ms-error-code header. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L100 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L110 |
||
All success responses except 202 & 204 should define a response body. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L120 |
||
Error response should contain a x-ms-error-code header. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L123 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L133 |
||
All success responses except 202 & 204 should define a response body. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L143 |
||
Error response should contain a x-ms-error-code header. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L146 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L156 |
||
Response body schema of pageable response should contain top-level array property value Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L168 |
||
Schema with type: string has unrecognized format: uri Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L168 |
||
Error response should contain a x-ms-error-code header. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L172 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L183 |
||
Parameter should have a description. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L194 |
||
The body parameter is not marked as required. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L194 |
||
Using post for a create operation is discouraged. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L214 |
||
All success responses except 202 & 204 should define a response body. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L214 |
||
Error response should contain a x-ms-error-code header. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L224 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L234 |
||
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.SDKReleasePlannerTest/stable/2022-08-13/sdkreleaseplannertest.json#L239 |
️️✔️
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.
️️✔️
~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 13 Errors, 0 Warnings failed [Detail]
️❌
SemanticValidation: 19 Errors, 0 Warnings failed [Detail]
️️✔️
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 Generation Artifacts
|
Generated ApiView
|
This was referenced Dec 13, 2022
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
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 - 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