-
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
[Hub Generated] Review request for Microsoft.ManagedServices to add version preview/2022-01-01-preview #17089
Conversation
…/2020-02-01-preview to version 2022-01-01-preview
Hi, @skayani 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 |
---|---|
R4009 - RequiredReadOnlySystemData |
The response of operation:'MarketplaceRegistrationDefinitions_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L483 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'MarketplaceRegistrationDefinitionsWithoutScope_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L522 |
Based on the response model schema, operation 'OperationsWithScope_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L591 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Registration Operations Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L619 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.ManagedServices/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L557 |
R4037 - MissingTypeObject |
The schema 'RegistrationDefinitionList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L737 |
R4037 - MissingTypeObject |
The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L818 |
R4037 - MissingTypeObject |
The schema 'RegistrationAssignmentList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L918 |
R4037 - MissingTypeObject |
The schema 'MarketplaceRegistrationDefinitionList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L1005 |
R4037 - MissingTypeObject |
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L1058 |
R4037 - MissingTypeObject |
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L1231 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L630 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L757 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L818 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L938 |
|
Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L558 |
|
'MarketplaceRegistrationDefinition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L936 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Registration Definitions Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L436 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Registration Definitions Location: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L514 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
~[Staging] 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.ManagedServices' for api version '2022-01-01-preview'. The supported api-versions are '2018-06-01-preview, 2019-04-01-preview, 2019-06-01, 2019-09-01, 2020-02-01-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]
- Compared Swaggers (Based on Oad v0.9.1)
- current:preview/2022-01-01-preview/managedservices.json compared with base:stable/2019-09-01/managedservices.json
- current:preview/2022-01-01-preview/managedservices.json compared with base:preview/2020-02-01-preview/managedservices.json
Rule | Message |
---|---|
The new version is missing a client parameter that was found in the old version. Was 'RegistrationDefinitionIdParameter' removed or renamed? New: Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json#L1242:3 Old: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L1173:3 |
️️✔️
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 @skayani, Your PR has some issues. Please fix the CI sequentially by following the order of
|
@akning-ms Not sure how to resolve the Python SDK issues. Can you give some pointers? |
You are saying pythons SDK breaking change? @msyyc to help python SDK issue. |
approved for python breaking change |
Hi @akning-ms I have fixed the prettier check issues. For the lint issue, that will remain unfixed because our RP doesn't implement systemData for the MarketplaceRegistrationDefinition data type (it is not customer facing anyway). Also for the registrationDefinitionIdParameter, it shouldn't be a breaking change as we pulled this from the latest preview API. Can we make sure this PR is merge-ready (but don't merge yet)? We will give ack on merge as soon as the new API is live. |
Hi @akning-ms , can you please ack on this PR? Once you do, I will update our RP manifest with the new version so that we can then merge this |
Hi @skayani, For registrationDefinitionIdParameter, as it is breaking your latest stable version, if your previous preview version is not get breaking change review board approval, you may have to get breaking change review board approval. if yes. can you show me the PR# for previous preivew version's approval? |
Hi @skayani, 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. |
...s/resource-manager/Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json
Outdated
Show resolved
Hide resolved
Signed off with comments from ARM perspective. |
Hi @skayani, I have approved your PR. Seems your service is not ready. Can I know when it will be deployed? I will help merge it when your service is deploy to production. |
Hey @akning-ms , I kicked off the RP manifest update job last week. I see the changes are in prod now, can we merge? |
@akning-ms Ping again, can we please merge the PR? |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
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.