Add Nginx.NginxPlus swagger version 2021-05-01-preview #18881
Merged
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
limingu
requested review from
msyyc,
BigCat20196,
ArcturusZhang,
jsntcy and
qiaozha
as code owners
|
Hi, @limingu 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 |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L827 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L915 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1156 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1203 |
|
| The child tracked resource, 'certificates' with immediate parent 'NginxDeployment', must have a list by immediate parent operation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L811 |
|
| The child tracked resource, 'configurations' with immediate parent 'NginxDeployment', must have a list by immediate parent operation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L899 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableDiagnosticsSupport Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1132 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableDiagnosticsSupport Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1180 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1256 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L514 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L574 |
|
| 'ProvisioningState' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L776 |
|
| 'NginxCertificateProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L794 |
|
| 'keyVirtualPath' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L800 |
|
| 'certificateVirtualPath' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L803 |
|
| 'keyVaultSecretId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L806 |
|
| 'NginxCertificate' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L811 |
|
| 'id' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L815 |
|
| 'name' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L819 |
|
| 'type' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L823 |
|
| 'tags' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L830 |
|
| 'location' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L836 |
|
| 'NginxCertificateListResponse' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L845 |
|
| 'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L848 |
|
| 'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L854 |
|
| 'NginxConfigurationFile' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L859 |
|
| 'content' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L862 |
|
| 'virtualPath' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L865 |
|
| 'NginxConfigurationPackage' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L870 |
|
| 'data' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L873 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️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 pipeline restarted successfully, please wait for status update in this comment. |
|
Hi @limingu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Please not to merge it until 5/23/2022. Thanks! |
honghr
added
the
DoNotMerge
|
Hi @honghr, could you please merge this PR? We are ready for the swagger to be public. Thanks! |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @limingu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
honghr
removed
DoNotMerge
honghr
approved these changes
May 17, 2022
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
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.
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:
5/24/2022
5/2022
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.