Features/gilads/add prom back to public #17339
Closed
Conversation
This file contains 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
* Added new Prometheus Rule Groups type * Added list example * Added missing brackets * Added to readme * Fixed readme * Added delete example * Added get example * Added create example * Added patch example * Test * Fixes * Added missing brace * Added rule group name * Fixed * Pretier * Tool fix * Update readme * Another prettier fix * More * Added system data * Removed referenced file * Removed system data * Added location to patch * Added back systemdata * Fixed systemdata * Changes * Fixed issue * Added operations * CR fixes * Using common parameters * Last CR fixes
|
Hi, @giladsu 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] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoResolved Location: Microsoft.AlertsManagement/preview/2021-07-22-preview/PrometheusRuleGroups.json#L534 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: common-types/resource-management/v3/types.json#L368 |
|
| 'PrometheusRule' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AlertsManagement/preview/2021-07-22-preview/PrometheusRuleGroups.json#L476 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ListResourcePrometheusRuleGroups Location: Microsoft.AlertsManagement/preview/2021-07-22-preview/PrometheusRuleGroups.json#L104 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: DeletePrometheusRuleGroup Location: Microsoft.AlertsManagement/preview/2021-07-22-preview/PrometheusRuleGroups.json#L314 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/alertsmanagement/resource-manager/readme.md tag: specification/alertsmanagement/resource-manager/readme.md#tag-package-2021-08 |
️❌~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.AlertsManagement' for api version '2021-07-22-preview'. The supported api-versions are '2017-11-15-privatepreview, 2018-05-05-preview, 2018-05-05, 2019-05-05-preview'." |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| "details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:Operations_List;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/ac8a4df35c24b954bf25cc84aa3f5550d4c657df/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-07-22-preview/PrometheusRuleGroups.json" |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
|
Hi @giladsu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @giladsu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
|
Hello - a few notes about this PR:
A couple questions:
|
giladsu
commented
Jan 13, 2022
| "required": [ | ||
| "scopes", | ||
| "rules" | ||
| ], |
There was a problem hiding this comment.
@yairgil @yanivlavi @NoamDishon - is there anything else that we should mark as required on the swagger level? maybe expression?
There was a problem hiding this comment.
Expression is the only other field that is mandatory, so yes.
j5lim
approved these changes
Jan 19, 2022
j5lim
added
ARMSignedOff
|
@j5lim - thank you for the signoff. Can you advise on what can be done to prevent documentation to be autogenerated? |
I think those questions more related to SDK. The SDK team should be able to help. |
|
What do you mean But I wonder why you want to have your API not documented. |
weidongxu-microsoft
approved these changes
Jan 20, 2022
|
Thanks @weidongxu-microsoft - we are currently only in private preview for 1P so the PMs requested that no public documentation will be generated for this resource type for now. Initially we planned to be in private repo in order to prevent this, but since we are integrating with Azure Service Operator it needs to be in the public repo. I will forward you a thread with some more details. |
weidongxu-microsoft
added
the
Approved-OkToMerge
|
Hi, @giladsu. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
closed this
|
Hi, @giladsu. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
This pull request was closed.
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.
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 apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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.