Swagger changes for new Predict API in Advisor RP #18168
Merged
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, @pedrobragioni 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. vscswagger@microsoft.com |
|
[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 |
|---|---|
| 'ArmErrorResponse' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Advisor/preview/2022-02-01-preview/predictRecommendation.json#L104 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌~[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.Advisor' for api version '2022-02-01-preview'. The supported api-versions are '2016-05-09-preview, 2016-07-12-preview, 2017-04-19, 2017-03-31, 2020-01-01, 2020-07-01-preview'." |
️️✔️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.
️️✔️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
|
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @pedrobragioni your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
This was referenced Mar 10, 2022
Member
|
@pedrobragioni - You checked that this PR was created by OpenAPIHub, but that doesn't appear to be the case. Using OpenAPIHub is not required, but if you are adding a new API version and making the PR yourself, it needs to be constructed correctly following this process:
This is required for ARM review. |
Member
|
@pedrobragioni Could you pls fix apiReadinessCheck failure? Could you paste your private approved PR here? |
Contributor
Author
|
@ruowan This is the private PR (https://github.com/Azure/azure-rest-api-specs-pr/pull/6329) that was already signed off by ARM and approved. |
Contributor
Author
|
@ruowan For the apiReadinessCheck failure, do we need to have the new api-version deployed? I thought we had to have this pr checked in before updating manifest. Do you know which order changes need to be made? |
raosuhas
reviewed
Mar 14, 2022
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "id": "/subscriptions/subscriptionId/providers/Microsoft.Advisor/predict/default", |
Contributor
Author
There was a problem hiding this comment.
We are not actually creating any resources. This is used for getting a prediction. Since it requires passing parameters in the body of the request, we are using POST.
There was a problem hiding this comment.
As discussed can you remove these 3 properties.
raosuhas
reviewed
Mar 14, 2022
| "description": "The list of operations.", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/OperationEntity" |
There was a problem hiding this comment.
Can you please use the common definitions for these ?
Contributor
Author
There was a problem hiding this comment.
I updated it to use the common definition.
raosuhas
reviewed
Mar 14, 2022
| }, | ||
| "extendedProperties": { | ||
| "description": "Extended properties are arguments specific for each prediction type.", | ||
| "type": "object" |
Contributor
Author
There was a problem hiding this comment.
This will be a generic API that can be used to make different predictions. Each prediction might require a different set of arguments and, because of that, we are having this free-form object here.
raosuhas
added
ARMSignedOff
ruowan
approved these changes
Apr 1, 2022
This was referenced Apr 1, 2022
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
May 16, 2022
* Add new preview api-version with predict api * Use common definition for Operation * Remove id, name and type from Predict response Co-authored-by: Pedro Las-Casas <pedrobr@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 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.
This PR is based on https://github.com/Azure/azure-rest-api-specs-pr/pull/6329, which has already been signed off by ARM and approved.