-
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
Pachaturvedi/elastic new version 2022 09 01 preview #21670
Pachaturvedi/elastic new version 2022 09 01 preview #21670
Conversation
Hi, @pachaturvedi 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] |
Hi, @pachaturvedi your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
elastic.json | 2022-07-01-preview(593832e) | 2022-07-01-preview(main) |
Rule | Message |
---|---|
1011 - AddingResponseCode |
The new version adds a response code '200'. New: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1083:11 |
1011 - AddingResponseCode |
The new version adds a response code '202'. New: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1086:11 |
1011 - AddingResponseCode |
The new version adds a response code '200'. New: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1150:11 |
1011 - AddingResponseCode |
The new version adds a response code '202'. New: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1153:11 |
1012 - RemovedResponseCode |
The new version removes the response code '201' Old: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1083:11 |
1012 - RemovedResponseCode |
The new version removes the response code '201' Old: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1144:11 |
️⚠️
Breaking Change(Cross-Version): 32 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
elastic.json | 2022-09-01-preview(593832e) | 2020-07-01(main) |
elastic.json | 2022-09-01-preview(593832e) | 2022-07-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️
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-2022-07-01-preview | package-2022-07-01-preview(593832e) | package-2022-07-01-preview(main) |
package-2022-09-01-preview | package-2022-09-01-preview(593832e) | default(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
XmsParameterLocation |
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L2263 |
XmsParameterLocation |
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L2281 |
XmsParameterLocation |
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L2268 |
XmsParameterLocation |
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L2276 |
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: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1444 |
|
Schema should have a description or title. Location: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1658 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1769 |
|
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: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1911 |
|
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: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1915 |
|
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: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1919 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L1970 |
|
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: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L2039 |
|
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: Microsoft.Elastic/preview/2022-07-01-preview/elastic.json#L2212 |
|
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: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L1444 |
|
Schema should have a description or title. Location: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L1658 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L1769 |
|
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: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L1911 |
|
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: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L1915 |
|
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: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L1919 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L1970 |
|
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: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L2044 |
|
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: Microsoft.Elastic/preview/2022-09-01-preview/elastic.json#L2217 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 23 Errors, 0 Warnings failed [Detail]
Tag package-2022-09-01-preview; Prod region: Deployed
Test run on region: centralindia; Operation coverage: total: 27, untested: 0, failed: 23, passed: 4
Service API Readiness Test failed. Check pipeline artifact for detail report.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 400, errorCode: InvalidResource, errorMessage: The resource definition is invalid. Source: runtime OperationId: Monitors_Create |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Monitors_Get |
CLIENT_ERROR |
statusCode: 400, errorCode: InvalidResource, errorMessage: The resource definition is invalid. Source: runtime OperationId: Monitors_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'monitornltk4oa' not found. Source: runtime OperationId: TagRules_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'monitornltk4oa' not found. Source: runtime OperationId: TagRules_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'monitornltk4oa' not found. Source: runtime OperationId: TagRules_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: AssociateTrafficFilter_Associate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: createAndAssociateIPFilter_Create |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: createAndAssociatePLFilter_Create |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ExternalUser_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: TrafficFilters_Delete |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: DetachAndDeleteTrafficFilter_Delete |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: DetachTrafficFilter_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: AllTrafficFilters_list |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: listAssociatedTrafficFilters_list |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: DeploymentInfo_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MonitoredResources_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: UpgradableVersions_Details |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: VMHost_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Monitor_Upgrade |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: VMCollection_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Elastic/monitors/monitornltk4oa' under resource group 'apiTest-gSUnXb-21670' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: VMIngestion_Details |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'monitornltk4oa' not found. Source: runtime OperationId: TagRules_Delete |
️️✔️
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
|
@ArcturusZhang Regarding Model validation failures, we've always been returning the status in the previous versions as well. Is this something for which we can get exception? |
Hi @pachaturvedi, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @pachaturvedi, 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. |
Hi, @pachaturvedi, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
@ArcturusZhang could you please help review this PR? |
...ification/elastic/resource-manager/Microsoft.Elastic/preview/2022-09-01-preview/elastic.json
Outdated
Show resolved
Hide resolved
...ification/elastic/resource-manager/Microsoft.Elastic/preview/2022-07-01-preview/elastic.json
Outdated
Show resolved
Hide resolved
...ification/elastic/resource-manager/Microsoft.Elastic/preview/2022-09-01-preview/elastic.json
Show resolved
Hide resolved
Please add x-ms-long-running-operation-options for long running operations https://github.com/Azure/azure-openapi-validator/blob/main/docs/long-running-operations-options-validator.md |
* base commit * update elastic.json & examples * Sync with azure-rest-api-specs-pr for 2022-09-01-preview * Update 202 response for long-running-operations in 2022-07-01 * Addressed review comments to fix ApiVersionParameter * Update response status to 200 for TrafficFilterCreate * Fix Swagger model validation error * fix prettier check * Update api version in examples * Addressed Review comments * Add Long running operation opeions
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.
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.
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.