Update agfood.json #3587
Open
Update agfood.json #3587
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
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| agfood.json | 2020-05-12-preview(5f66a7d) | 2020-05-12-preview(main) |
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}' removed or restructured? Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L9:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L9:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️❌LintDiff: 6 Errors, 0 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2020-05-12-preview | package-2020-05-12-preview(5f66a7d) | package-2020-05-12-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L9 |
RPC-Put-V1-01 |
|
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L9 |
RPC-Uri-V1-05 |
|
The parameters:extensionId,farmBeatsResourceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L10 |
|
|
The parameters:extensionId,farmBeatsResourceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L56 |
|
|
The parameters:extensionId,farmBeatsResourceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L102 |
|
|
The parameters:extensionId,farmBeatsResourceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L148 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L195 |
|
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L412 |
|
The parameters:farmBeatsResourceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L456 |
|
The parameters:farmBeatsResourceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L517 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L542 |
|
The top-level resource 'FarmBeatsExtension' does not have list by subscription operation, please add it. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L1039 |
| The API version:2020-05-12-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L6 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L1124 |
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 6 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️⚠️[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/openapi-env-test/azure-rest-api-specs/blob/5f66a7d8962514b798d7473a3635d07f34eaa25e/specification/agrifood/resource-manager/readme.md#tag-package-2020-05-12-preview">agrifood/resource-manager/readme.md#package-2020-05-12-preview
| Rule | Message |
|---|---|
| "readme":"agrifood/resource-manager/readme.md", "tag":"package-2020-05-12-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
|
Swagger pipeline started successfully, please wait for status update in this comment. |
1 similar comment
|
Swagger pipeline started successfully, please wait for status update in this comment. |
|
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
Swagger Generation Artifacts
|
Generated ApiView
|
|
/azp run |
|
No pipelines are associated with this pull request. |
ruowan
added
BreakingChangeReviewRequired
and removed
BreakingChangeReviewRequired
labels
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
No pipelines are associated with this pull request. |
MaryGao
requested review from
msyyc,
ArcturusZhang,
qiaozha and
mikekistler
as code owners
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
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 appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] 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.