add certs/domains new version folders and readme required changes #20857
Conversation
This file contains 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, @edwin-msft 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 |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| AppServiceCertificateOrders.json | 2022-09-01(8fb0bc1) | 2022-03-01(main) |
| CertificateOrdersDiagnostics.json | 2022-09-01(8fb0bc1) | 2022-03-01(main) |
| CertificateRegistrationProvider.json | 2022-09-01(8fb0bc1) | 2022-03-01(main) |
| DomainRegistrationProvider.json | 2022-09-01(8fb0bc1) | 2022-03-01(main) |
| Domains.json | 2022-09-01(8fb0bc1) | 2022-03-01(main) |
| TopLevelDomains.json | 2022-09-01(8fb0bc1) | 2022-03-01(main) |
️⚠️LintDiff: 21 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-09 | package-2022-09(8fb0bc1) | package-2022-09(release-web-Microsoft.Web-2022-09-01) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 'PUT' operation 'Domains_TransferOut' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L788 |
||
| The operation 'Domains_Update' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L392 |
||
| The operation 'Domains_Renew' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L733 |
||
| OperationId should contain the verb: 'validatecertificateregistrationinformation' in:'AppServiceCertificateOrders_ValidatePurchaseInformation'. Consider updating the operationId Location: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json#L65 |
||
| OperationId should contain the verb: 'retrieveemailhistory' in:'AppServiceCertificateOrders_RetrieveCertificateEmailHistory'. Consider updating the operationId Location: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json#L996 |
||
| OperationId should contain the verb: 'checkdomainavailability' in:'Domains_CheckAvailability'. Consider updating the operationId Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L25 |
||
| OperationId should contain the verb: 'generatessorequest' in:'Domains_GetControlCenterSsoRequest'. Consider updating the operationId Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L111 |
||
| OperationId should contain the verb: 'listdomainrecommendations' in:'Domains_ListRecommendations'. Consider updating the operationId Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L148 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: lightTheme Location: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json#L1745 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: forceHardDeleteDomain Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L360 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: available Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L1138 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: includePrivacy Location: Microsoft.DomainRegistration/stable/2022-09-01/TopLevelDomains.json#L237 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: forTransfer Location: Microsoft.DomainRegistration/stable/2022-09-01/TopLevelDomains.json#L241 |
||
| 'CertificateOrderContact' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json#L1643 |
||
| 'email' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json#L1646 |
||
| 'nameFirst' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json#L1649 |
||
| 'nameLast' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json#L1652 |
||
| 'phone' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CertificateRegistration/stable/2022-09-01/AppServiceCertificateOrders.json#L1655 |
||
| 'authCode' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L1118 |
||
| 'authCode' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DomainRegistration/stable/2022-09-01/Domains.json#L1440 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List operations Location: Microsoft.DomainRegistration/stable/2022-09-01/DomainRegistrationProvider.json#L45 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️SDK Track2 Validation: 3 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/8fb0bc15a6d16c24d519c83a12e5e32929c588a4/specification/web/resource-manager/readme.md#tag-package-2022-09">web/resource-manager/readme.md#package-2022-09
| Rule | Message |
|---|---|
| "readme":"web/resource-manager/readme.md", "tag":"package-2022-09", "details":"The schema 'ExpressionTraces-value' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2022-09-01/WebApps.json#/components/schemas/ExpressionTraces-value" |
|
| "readme":"web/resource-manager/readme.md", "tag":"package-2022-09", "details":"The schema 'Expression-value' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2022-09-01/WebApps.json#/components/schemas/Expression-value" |
|
| "readme":"web/resource-manager/readme.md", "tag":"package-2022-09", "details":"The schema 'OperationResultProperties-error' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2022-09-01/WebApps.json#/components/schemas/OperationResultProperties-error" |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| "readme":"web/resource-manager/readme.md", "tag":"package-2022-09", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
|
Hi @edwin-msft, Your PR has some issues. Please fix the CI sequentially by following the order of
|
AzureRestAPISpecReview
added
ARMReview
ReadyForApiTest
This was referenced Sep 23, 2022
This was referenced Sep 23, 2022
|
@edwin-msft @naveedaz |
|
Also let us know if future PR to the dev branch require ARM review. |
Correct, just a copy to new api-version 2022-09-01. No API change. |
weidongxu-microsoft
approved these changes
Sep 30, 2022
|
Could you also notify Navy? I remember usually he make this kind of feature branch. At least make sure Navy aware of this feature branch. |
weidongxu-microsoft
approved these changes
Sep 30, 2022
naveedaz
approved these changes
Sep 30, 2022
Yes he usually makes these PRs and he walked me through the steps in generating these for my knowledge |
Yes, goal is for ARM review for dev PRs to release version branch in order to avoid ARM review (and feedback loop) on gigantic PR to main branch |
weidongxu-microsoft
merged commit 2ab94c0
into
Azure:release-web-Microsoft.Web-2022-09-01
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[X] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.