add multidimentional RCA API #16924
Closed
add multidimentional RCA API #16924
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
|
Hi, @suxi-ms 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 |
|---|---|
| 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'UploadMultiDimRCAData', Response code: '201' Location: AnomalyDetector/preview/v2.0-preview/MultidimensionalRootCauseAnalysis.json#L219 |
|
| Guid used in model definition 'MultiDimRCADataSetDetail' for property 'dataSetId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultidimensionalRootCauseAnalysis.json#L1001 |
|
| Guid used in model definition 'MultiDimRCATargetMeasure' for property 'dataSetId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultidimensionalRootCauseAnalysis.json#L1494 |
|
| Guid used in model definition 'MultiDimRCADataScope' for property 'dataSetId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultidimensionalRootCauseAnalysis.json#L1512 |
|
| Guid used in model definition 'MultiDimRCAInstanceResponse' for property 'instanceId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultidimensionalRootCauseAnalysis.json#L1575 |
|
| Guid used in model definition 'MultiDimRCATrainingResponse' for property 'taskId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultidimensionalRootCauseAnalysis.json#L1741 |
|
| Guid used in model definition 'MultiDimRootCauseMeasure' for property 'dataSetId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultidimensionalRootCauseAnalysis.json#L1863 |
|
| Guid used in model definition 'MultiDimRCAInferenceResponse' for property 'inferenceId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultidimensionalRootCauseAnalysis.json#L1947 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Guid used in model definition 'Model' for property 'modelId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultivariateAnomalyDetector.json#L353 |
|
| Guid used in model definition 'ModelSnapshot' for property 'modelId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultivariateAnomalyDetector.json#L724 |
|
| Guid used in model definition 'DetectionResult' for property 'resultId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: AnomalyDetector/preview/v2.0-preview/MultivariateAnomalyDetector.json#L826 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.9.1)
- current:preview/v2.0-preview/AnomalyDetector.json compared with base:stable/v1.0/AnomalyDetector.json
- current:preview/v2.0-preview/AnomalyDetector.json compared with base:preview/v1.1-preview/AnomalyDetector.json
- current:preview/v2.0-preview/MultivariateAnomalyDetector.json compared with base:preview/v1.1-preview/MultivariateAnomalyDetector.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: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Code style issues found path: AnomalyDetector/preview/v2.0-preview/MultidimensionalRootCauseAnalysis.json |
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi @suxi-ms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Dec 1, 2021
Member
|
Have these APIs been reviewed by the API review board? |
Contributor
Author
Not yet. We are scheduling the review time with review board. |
mikekistler
reviewed
Dec 16, 2021
Member
mikekistler
left a comment
mikekistler
left a comment
There was a problem hiding this comment.
I made a quick pass and found a few issues.
| "type": "string" | ||
| } | ||
| } | ||
| }, |
Member
There was a problem hiding this comment.
All success responses except 202 & 204 should define a response body.
| "@nextLink": { | ||
| "description": "Link of next page, only provided when there are next pages", | ||
| "type": "string", | ||
| "readOnly": true |
Member
There was a problem hiding this comment.
There is no need to define nextLink as readOnly: true as this schema is only used in a response.
| }, | ||
| { | ||
| "in": "query", | ||
| "name": "$skip", |
Member
There was a problem hiding this comment.
DO NOT use the "$" prefix on OData query parameter names -- the Azure standard is to drop the "$".
| }, | ||
| { | ||
| "in": "query", | ||
| "name": "$maxpagesize", |
Member
There was a problem hiding this comment.
Don't use "$" in query parameter names.
| ], | ||
| "type": "object", | ||
| "properties": { | ||
| "@nextLink": { |
Member
There was a problem hiding this comment.
Don't use the "@" in the name of the nextLink property of pageable responses.
| "description": "create a multidimensional root cause analysis data set request", | ||
| "schema": { | ||
| "$ref": "#/definitions/CreateMultiDimRCADatasetRequest" | ||
| } |
Member
There was a problem hiding this comment.
Should this body parameter be marked as required? The body schema has required fields so it seems unlikely that the entire body is optional.
| "description": "Data to be uploaded to perform multidimensional root cause analysis", | ||
| "schema": { | ||
| "$ref": "#/definitions/MultiDimRCAUploadDataRequest" | ||
| } |
Member
There was a problem hiding this comment.
Should body parameter be required?
| "description": "Create a multidimensional RCA instance request", | ||
| "schema": { | ||
| "$ref": "#/definitions/MultiDimRCAInstanceRequest" | ||
| } |
Member
There was a problem hiding this comment.
Should body parameter be required?
| "schema": { | ||
| "$ref": "#/definitions/MultiDimRCATrainingRequest" | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
Should body parameter be required?
| "description": "Inference request of multidimensional RCA", | ||
| "schema": { | ||
| "$ref": "#/definitions/MultiDimRCAInferenceRequest" | ||
| } |
Member
There was a problem hiding this comment.
Should body parameter be required?
|
Hi, @suxi-ms. 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 |
|
Hi, @suxi-ms. 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, @suxi-ms. 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
3 participants
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.