azure-rest-api-specs
azure-rest-api-specs copied to clipboard
[Nginx] Specify host and schemes
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:
- What's the purpose of the update?
- [ ] new service onboarding
- [ ] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [ ] SDK of .NET (need service team to ensure code readiness)
- [ ] SDK of Python
- [ ] SDK of Java
- [ ] SDK of Js
- [ ] SDK of Go
- [x] PowerShell
- [ ] CLI
- [ ] Terraform
- [ ] No refresh required for updates in this PR
Contribution checklist:
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [ ] I have reviewed the documentation for the workflow.
- [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] 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.
- [ ] Removing API(s) in a stable version
- [ ] Removing properties in a stable version
- [ ] Removing API version(s) in a stable version
- [ ] Updating API in a stable or public preview version with Breaking Change Validation errors
- [ ] Updating API(s) in public preview over 1 year (refer to Retirement of Previews)
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.
Hi, @limingu Thanks for your PR. I am workflow bot for review process. Here are some small tips.
Swagger Validation Report
️️✔️
BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.9.7)] | new version | base version |
---|---|---|
swagger.json | 2021-05-01-preview(c4627c4) | 2021-05-01-preview(main) |
swagger.json | 2022-08-01(c4627c4) | 2022-08-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-08-01 | package-2022-08-01(c4627c4) | package-2022-08-01(main) |
package-2021-05-01-preview | package-2021-05-01-preview(c4627c4) | package-2021-05-01-preview(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L837 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L925 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1166 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1213 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L837 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L925 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L1188 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L1238 |
:warning: R3010 - TrackedResourceListByImmediateParent | 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#L821 |
:warning: R3010 - TrackedResourceListByImmediateParent | 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#L909 |
:warning: R3010 - TrackedResourceListByImmediateParent | 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#L821 |
:warning: R3010 - TrackedResourceListByImmediateParent | 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#L909 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1142 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1190 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1266 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1161 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1212 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1291 |
:warning: R4000 - ParameterDescriptionRequired | '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#L524 |
:warning: R4000 - ParameterDescriptionRequired | '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#L584 |
:warning: R4000 - ParameterDescriptionRequired | '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#L524 |
:warning: R4000 - ParameterDescriptionRequired | '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#L584 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L786 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L804 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L810 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L813 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L816 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L821 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L825 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L829 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[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 'deploymentebx0j4' 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 'deploymentebx0j4' 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/c4627c4edc2cea352a6df2a3d9baedfa1b7a1789/specification/nginx/resource-manager/readme.md#tag-package-2022-08-01">nginx/resource-manager/readme.md#package-2022-08-01
- "https://github.com/Azure/azure-rest-api-specs/blob/c4627c4edc2cea352a6df2a3d9baedfa1b7a1789/specification/nginx/resource-manager/readme.md#tag-package-2021-05-01-preview">nginx/resource-manager/readme.md#package-2021-05-01-preview
️️✔️
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
️️✔️
ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️
SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
️✔️
azure-sdk-for-go - armnginx - 1.0.0️✔️
azure-sdk-for-python-track2 - track2_azure-mgmt-nginx - 1.0.0b1️❌
azure-sdk-for-net failed [Detail]
❌
Failed [Logs]Release - Generate from 993f888cb0b9a825cf214a9bb0a417751e14a482. SDK Automation 14.0.0warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-6.0 command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/nginx/resource-manager/readme.md cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] No usable version of the libssl was found cmderr [Autorest] FATAL: csharp/simplifier - FAILED cmderr [Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. cmderr [Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest warn Skip package processing as generation is failed
️⚠️
azure-sdk-for-python-track2 warning [Detail]
⚠️
Warning [Logs]Release - Generate from 993f888cb0b9a825cf214a9bb0a417751e14a482. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead. cmderr [automation_generate.sh] npm notice cmderr [automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.18.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.18.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️
track2_azure-mgmt-nginx [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Model NginxDeploymentProperties has a new parameter logging info [Changelog] - Model NginxDeploymentUpdateProperties has a new parameter logging
️️✔️
azure-sdk-for-java succeeded [Detail] [Expand]
️✔️
Succeeded [Logs]Release - Generate from 993f888cb0b9a825cf214a9bb0a417751e14a482. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️
azure-resourcemanager-nginx [View full logs] [Release SDK Changes]
️️✔️
azure-sdk-for-go succeeded [Detail] [Expand]
️✔️
Succeeded [Logs]Release - Generate from 993f888cb0b9a825cf214a9bb0a417751e14a482. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️
armnginx [View full logs] [Release SDK Changes]info [Changelog] This is a new package info [Changelog]
️️✔️
azure-sdk-for-js succeeded [Detail] [Expand]
️✔️
Succeeded [Logs]Release - Generate from 993f888cb0b9a825cf214a9bb0a417751e14a482. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️
@azure/arm-nginx [View full logs] [Release SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️
azure-resource-manager-schemas warning [Detail]
⚠️
Warning [Logs]Release - Generate from 993f888cb0b9a825cf214a9bb0a417751e14a482. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️✔️
nginx [View full logs] [Release Schema Changes]
️️✔️
azure-powershell succeeded [Detail] [Expand]
️✔️
Succeeded [Logs]Release - Generate from 993f888cb0b9a825cf214a9bb0a417751e14a482. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
️✔️
Az.Nginx [View full logs] [Release SDK Changes]
Generated ApiView
Language | Package Name | ApiView Link |
---|---|---|
Python | track2_azure-mgmt-nginx | https://apiview.dev/Assemblies/Review/3c2e686c7d6640559768d805c0280260 |
Java | azure-resourcemanager-nginx | https://apiview.dev/Assemblies/Review/bcab62b27bed4dc6ad146d380710dac7 |
JavaScript | @azure/arm-nginx | https://apiview.dev/Assemblies/Review/a2ff9e33877d4299a4e0187cfc56f410 |
Swagger Validation Report
️🔄
BreakingChange inProgress [Detail]
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⌛
CredScan pending [Detail]
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-08-01 | package-2022-08-01(c4627c4) | package-2022-08-01(main) |
package-2021-05-01-preview | package-2021-05-01-preview(c4627c4) | package-2021-05-01-preview(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L837 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L925 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1166 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1213 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L837 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L925 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L1188 |
:warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L1238 |
:warning: R3010 - TrackedResourceListByImmediateParent | 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#L821 |
:warning: R3010 - TrackedResourceListByImmediateParent | 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#L909 |
:warning: R3010 - TrackedResourceListByImmediateParent | 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#L821 |
:warning: R3010 - TrackedResourceListByImmediateParent | 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#L909 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1142 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1190 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1266 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1161 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1212 |
:warning: R3018 - EnumInsteadOfBoolean | 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#L1291 |
:warning: R4000 - ParameterDescriptionRequired | '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#L524 |
:warning: R4000 - ParameterDescriptionRequired | '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#L584 |
:warning: R4000 - ParameterDescriptionRequired | '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#L524 |
:warning: R4000 - ParameterDescriptionRequired | '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#L584 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L786 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L804 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L810 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L813 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L816 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L821 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L825 |
:warning: R4021 - DescriptionAndTitleMissing | '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#L829 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️🔄
ApiReadinessCheck inProgress [Detail]
️🔄
~[Staging] ServiceAPIReadinessTest inProgress [Detail]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⌛
PoliCheck pending [Detail]
️️✔️
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/c4627c4edc2cea352a6df2a3d9baedfa1b7a1789/specification/nginx/resource-manager/readme.md#tag-package-2022-08-01">nginx/resource-manager/readme.md#package-2022-08-01
- "https://github.com/Azure/azure-rest-api-specs/blob/c4627c4edc2cea352a6df2a3d9baedfa1b7a1789/specification/nginx/resource-manager/readme.md#tag-package-2021-05-01-preview">nginx/resource-manager/readme.md#package-2021-05-01-preview
️️✔️
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.