-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Microsoft.ProviderHub: Add new API version 2021-06-01-preview #14650
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
Conversation
Hi, @diwudd 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 |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3837 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3861 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: origin Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3814 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: actionType Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3830 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2488 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3810 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4359 |
|
'ProvisioningState' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2199 |
|
'expeditedRollout' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2497 |
|
'LocalizedOperationDisplayDefinition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3647 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2373 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2637 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3541 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3627 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4143 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4595 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4831 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdate' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource' Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L1326 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdateNestedResourceTypeFirst' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource' Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L1478 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdateNestedResourceTypeSecond' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource' Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L1639 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 14 Errors, 8 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:preview/2021-06-01-preview/providerhub.json compared with base:preview/2021-05-01-preview/providerhub.json
- current:preview/2021-06-01-preview/providerhub.json compared with base:stable/2020-11-20/providerhub.json
Only 10 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
[Staging] SDK Track2 Validation: 1 Errors, 6 Warnings failed [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
AutorestCore/Exception |
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"Error: Plugin pre-namer reported failure." |
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'ResourceProviderManagement-resourceAccessRolesItem' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/ResourceProviderManagement-resourceAccessRolesItem" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'ResourceProviderManifestProperties-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/ResourceProviderManifestProperties-metadata" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'ResourceType-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/ResourceType-metadata" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'ResourceProviderManifest-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/ResourceProviderManifest-metadata" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'OperationsDefinition-properties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/OperationsDefinition-properties" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'LocalizedOperationDefinition-properties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/LocalizedOperationDefinition-properties" |
|
💬 AutorestCore/Exception | "readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
💬 AutorestCore/Exception | "readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️❌
[Staging] Lint(RPaaS): 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
R4031 - Rpaas_ResourceProvisioningState |
[RPaaS] The resource NotificationRegistration is defined without 'provisioningState' in properties bag, consider adding the provisioningState for it. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3467 |
R4031 - Rpaas_ResourceProvisioningState |
[RPaaS] The resource SkuResource is defined without 'provisioningState' in properties bag, consider adding the provisioningState for it. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4532 |
Swagger Generation Artifacts
|
/listResources ? Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2139 in c079edd. [](commit_id = c079edd, deletion_comment = False) |
/resourceOperations/default/getResource? In reply to: 854133036 Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2139 in 925a247. [](commit_id = 925a247, deletion_comment = False) |
/resourceOperations/default/listResources? Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2194 in c079edd. [](commit_id = c079edd, deletion_comment = False) |
remove {resourceActionName} parameter In reply to: 854261751 Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2194 in 925a247. [](commit_id = 925a247, deletion_comment = False) |
Take a different payload for list call, including OData filter that current LIST call for cross partition query takes. Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2219 in c079edd. [](commit_id = c079edd, deletion_comment = False) |
check ARG list call that is similar to this. POST providers/Microsoft.ResourceGraph/resources In reply to: 854262122 Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2219 in 925a247. [](commit_id = 925a247, deletion_comment = False) |
consdier moving under /ResourceTypeRegistrations/ as John suggested, as it will allow ARM to RBAC the user based on the Role. This is useful with multi-registration model Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2194 in c079edd. [](commit_id = c079edd, deletion_comment = False) |
it could be tracked resource as well. Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2176 in c079edd. [](commit_id = c079edd, deletion_comment = False) |
use TrackedResource definition, unless it has location as required property in the v2 definition In reply to: 854264300 Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2176 in 925a247. [](commit_id = 925a247, deletion_comment = False) |
should this take a an option to invoke UserRP extensions ? Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2274 in c079edd. [](commit_id = c079edd, deletion_comment = False) |
same here. it may not always be proxy Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:5010 in c079edd. [](commit_id = c079edd, deletion_comment = False) |
...ource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CheckinManifest.json
Outdated
Show resolved
Hide resolved
Hi, @diwudd. 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 |
You need to pass ARM review. |
@diwudd - Changed LGTM. Signed off from ARM side. |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.