Add NGINX.NGINXPLUS swagger version 2022-08-01#20185
Add NGINX.NGINXPLUS swagger version 2022-08-01#20185jordan13game merged 3 commits intoAzure:mainfrom
Conversation
|
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 |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| swagger.json | 2022-08-01(4a495bd) | 2021-05-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 4 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-08-01 | package-2022-08-01(4a495bd) | default(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| 'NginxStorageAccount' 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/stable/2022-08-01/swagger.json#L1110 |
|
| 'accountName' 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/stable/2022-08-01/swagger.json#L1113 |
|
| 'containerName' 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/stable/2022-08-01/swagger.json#L1116 |
|
| 'NginxLogging' 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/stable/2022-08-01/swagger.json#L1121 |
The following errors/warnings exist before current PR submission:
Only 30 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: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L827 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L915 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L1178 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L1228 |
|
| The child tracked resource, 'certificates' with immediate parent 'NginxDeployment', must have a list by immediate parent operation. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L811 |
|
| The child tracked resource, 'configurations' with immediate parent 'NginxDeployment', must have a list by immediate parent operation. Location: NGINX.NGINXPLUS/stable/2022-08-01/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/stable/2022-08-01/swagger.json#L1151 |
|
| 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/stable/2022-08-01/swagger.json#L1202 |
|
| 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/stable/2022-08-01/swagger.json#L1281 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L514 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: NGINX.NGINXPLUS/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/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/stable/2022-08-01/swagger.json#L873 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌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 'Nginx.NginxPlus' for api version '2022-08-01'. The supported api-versions are '2021-05-01-preview'." |
️❌~[Staging] ServiceAPIReadinessTest: 30 Errors, 0 Warnings failed [Detail]
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'deployment47dp2s' not found." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'deployment47dp2s' not found." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'operations' could not be found in the namespace 'Nginx.NginxPlus' for api version '2022-08-01'. The supported api-versions are '2021-05-01-preview'." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 404" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
RUNTIME_ERROR |
"statusCode: 400, errorCode: MissingApiVersionParameter, errorMessage: The api-version query parameter (?api-version=) is required for all requests." |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: expected response code to be 2XX but found 400" |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/4a495bd4087e99eaf81d94f9653b4a650fef40eb/specification/nginx/resource-manager/readme.md#tag-package-2022-08-01">nginx/resource-manager/readme.md#package-2022-08-01
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
Generated ApiView
|
|
This PR is just copying the current api version from azure-rest-api-specs-pr to azure-rest-api-specs. Some readme files are updated as well. |
|
NewApiVersionRequired reason: |
specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json
Outdated
Show resolved
Hide resolved
|
Hi @limingu, 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. |
|
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). |
|
The private reop PR: https://github.com/Azure/azure-rest-api-specs-pr/pull/8203 |
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:
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 appy 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.
-[ ] 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.