-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Api freshness variable changed #22430
Conversation
Hi, @manikprabhu1208 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 |
---|---|---|
agfood.json | 2021-09-01-preview(4a41c5f) | 2021-09-01-preview(main) |
Rule | Message |
---|---|
1033 - RemovedProperty |
The new version is missing a property found in the old version. Was 'apiFreshnessWindowInMinutes' renamed or removed? New: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1622:7 Old: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1622:7 |
1041 - AddedPropertyInResponse |
The new version has a new property 'apiFreshnessTimeInMinutes' in response that was not found in the old version. New: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1622:7 Old: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1622: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-preview-2021-09 | package-preview-2021-09(4a41c5f) | package-preview-2021-09(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L9 |
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L166 |
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L383 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property location. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L513 |
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L721 |
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L867 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L867 |
GetCollectionResponseSchema |
The response in the GET collection operation 'PrivateEndpointConnections_ListByResource' does not match the response definition in the individual GET operation 'PrivateEndpointConnections_Get' . Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1050 |
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1050 |
GetCollectionResponseSchema |
The response in the GET collection operation 'PrivateLinkResources_ListByResource' does not match the response definition in the individual GET operation 'PrivateLinkResources_Get' . Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1098 |
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1098 |
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1146 |
ResourceNameRestriction |
The resource name parameter 'subResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1146 |
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1205 |
RepeatedPathInfo |
The 'solutionId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1228 |
ResourceNameRestriction |
The resource name parameter 'farmBeatsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1362 |
TopLevelResourcesListBySubscription |
The top-level resource 'FarmBeatsExtension' does not have list by subscription operation, please add it. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1867 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1909 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1952 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L2366 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L2372 |
TopLevelResourcesListBySubscription |
The top-level resource 'FarmBeatsSolution' does not have list by subscription operation, please add it. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L2402 |
The API version:2021-09-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L6 |
|
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: 'Extensions_CreateOrUpdate' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L10 |
|
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: 'Solutions_CreateOrUpdate' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L1206 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L2015 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L2022 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L2122 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L2139 |
|
Schema should have a description or title. Location: Microsoft.AgFoodPlatform/preview/2021-09-01-preview/agfood.json#L2171 |
️️✔️
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 Generation Artifacts
|
Generated ApiView
|
Hi @manikprabhu1208, 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 |
Azure Pipelines successfully started running 1 pipeline(s). |
ARM API Information (Control Plane)
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.
We only changed “ApiFreshnessWindowInMinutes” to “ApiFreshnessTimeInMinutes” in the PR. We got feedback from the customers that the word “window” is causing confusion regarding the purpose of this variable. This is not a window but rather a time period for which we are going to refresh weather data in cache.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.