-
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
[Microsoft.ApiManagement][2020-06-01-preview] Gateway certificate authorities #12559
Conversation
Hi, @maksimkim 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] |
Swagger Validation Report
|
Rule | Message |
---|---|
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.ApiManagement/preview/2020-06-01-preview/apimgateways.json#L1033:5 |
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.ApiManagement/preview/2020-06-01-preview/apimgateways.json#L1095:5 |
️❌
LintDiff: 2 Errors, 3 Warnings failed [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
Rule | Message |
---|---|
R4009 - RequiredSystemDataInNewApiVersions |
The response of operation:'GatewayCertificateAuthority_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/preview/2020-06-01-preview/apimgateways.json#L1145 |
R4009 - RequiredSystemDataInNewApiVersions |
The response of operation:'GatewayCertificateAuthority_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/preview/2020-06-01-preview/apimgateways.json#L1197 |
The child tracked resource, 'certificateAuthorities' with immediate parent 'GatewayContract', must have a list by immediate parent operation. Location: Microsoft.ApiManagement/preview/2020-06-01-preview/definitions.json#L37 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isTrusted Location: Microsoft.ApiManagement/preview/2020-06-01-preview/definitions.json#L6063 |
|
'parameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.ApiManagement/preview/2020-06-01-preview/apimgateways.json#L1224 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 301 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'ErrorFieldContract' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'ErrorResponseBody' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'RegionContract' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'RegionListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'ResourceSkuResults' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'ResourceSkuResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'ResourceSkuCapacity' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"apimanagement/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'ResourceSku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️❌
[Staging] SpellCheck: 4 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Unknown word (Authoritiy), please fix the error or add words to ./custom-words.txt path: Microsoft.ApiManagement/preview/2020-06-01-preview/apimgateways.json#L1077:63 |
HowToFix |
Unknown word (identifer), please fix the error or add words to ./custom-words.txt path: Microsoft.ApiManagement/preview/2020-06-01-preview/definitions.json#L861:74 |
HowToFix |
Unknown word (identifer), please fix the error or add words to ./custom-words.txt path: Microsoft.ApiManagement/preview/2020-06-01-preview/definitions.json#L888:74 |
HowToFix |
Unknown word (identifer), please fix the error or add words to ./custom-words.txt path: Microsoft.ApiManagement/preview/2020-06-01-preview/definitions.json#L966:74 |
Swagger Generation Artifacts
|
Hi, @maksimkim your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @yungezz |
NewApiVersionRequired reason: |
Hi @maksimkim, Your PR has some issues. Please fix the CI sequentially by following the order of
|
...ment/preview/2020-06-01-preview/examples/ApiManagementListGatewayCertificateAuthorities.json
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One nit comment on the count
...gement/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimgateways.json
Show resolved
Hide resolved
...agement/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/definitions.json
Show resolved
Hide resolved
waiting for ARM feedback since new APIs added. |
hi @msyyc, could you pls confirm impact to Python SDK? thanks |
...gement/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimgateways.json
Show resolved
Hide resolved
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
@yungezz can you take a look again? This is signed off from ARM and Breaking Change team |
@yungezz we have not released python sdk for this preview api-version |
thanks. could you pls fix CI failure? and is the change deployed to Prod already? |
Copy of the changes was merged |
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 API 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.