-
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
Adding new version 2023-05-01-preview for adding an additional parameter in "MarketplaceSaaSInfo" response #24031
Adding new version 2023-05-01-preview for adding an additional parameter in "MarketplaceSaaSInfo" response #24031
Conversation
Hi, @RheaHooda23 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 |
---|---|---|
elastic.json | 2023-05-01-preview(f4fbc53) | 2020-07-01(main) |
elastic.json | 2023-05-01-preview(f4fbc53) | 2023-02-01-preview(main) |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.2) | new version | base version |
---|---|---|
package-2023-05-01-preview | package-2023-05-01-preview(f4fbc53) | 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/2023-05-01-preview/elastic.json#L2470 |
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/2023-05-01-preview/elastic.json#L2478 |
The summary and description values should not be same. Location: Microsoft.Elastic/preview/2023-05-01-preview/elastic.json#L1424 |
|
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/2023-05-01-preview/elastic.json#L1544 |
|
Schema should have a description or title. Location: Microsoft.Elastic/preview/2023-05-01-preview/elastic.json#L1758 |
|
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/2023-05-01-preview/elastic.json#L1806 |
|
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/2023-05-01-preview/elastic.json#L2051 |
|
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/2023-05-01-preview/elastic.json#L2055 |
|
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/2023-05-01-preview/elastic.json#L2059 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Elastic/preview/2023-05-01-preview/elastic.json#L2141 |
|
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/2023-05-01-preview/elastic.json#L2217 |
|
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/2023-05-01-preview/elastic.json#L2390 |
|
Schema should have a description or title. Location: Microsoft.Elastic/preview/2023-05-01-preview/elastic.json#L2458 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Elastic' for api version '2023-05-01-preview'. The supported api-versions are '2020-07-01-preview, 2020-07-01, 2021-09-01-preview, 2021-10-01-preview, 2022-05-05-preview, 2022-07-01-preview, 2022-09-01-preview, 2023-02-01-preview'." |
️⚠️
~[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]
️️✔️
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.
️️✔️
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.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @RheaHooda23 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Hi @RheaHooda23, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @RheaHooda23, 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 |
@RheaHooda23 Please contact the |
@RheaHooda23 The api readiness check is failing, have you deployed your manifest? |
Hey @v-xuto No, I have not yet deployed. |
Are you planning to deploy it sooner after this PR get merged ?Because once this PR merged into main branch, it's public to the customer. If yes, I can merged this PR. otherwise, customer may get errors like api version is not available. |
I'll deploy this today. No, it won't cause customer any issues because we haven't exposed this version yet. Yes, you can merge this PR. Thank you! |
ARM API Information (Control Plane)
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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.