Skip to content

Comments

Add NGINX.NGINXPLUS swagger version 2022-08-01#20185

Merged
jordan13game merged 3 commits intoAzure:mainfrom
limingu:nginx8822
Aug 17, 2022
Merged

Add NGINX.NGINXPLUS swagger version 2022-08-01#20185
jordan13game merged 3 commits intoAzure:mainfrom
limingu:nginx8822

Conversation

@limingu
Copy link
Member

@limingu limingu commented Aug 11, 2022

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:

  1. 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
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. 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
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

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.

@limingu limingu requested a review from ArcturusZhang as a code owner August 11, 2022 04:20
@openapi-workflow-bot
Copy link

Hi, @limingu Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 11, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L827
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L915
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L1178
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L1228
    ⚠️ 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#L811
    ⚠️ 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#L899
    ⚠️ 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#L1151
    ⚠️ 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#L1202
    ⚠️ 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#L1281
    ⚠️ 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#L514
    ⚠️ 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#L574
    ⚠️ 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/stable/2022-08-01/swagger.json#L776
    ⚠️ 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/stable/2022-08-01/swagger.json#L794
    ⚠️ 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/stable/2022-08-01/swagger.json#L800
    ⚠️ 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/stable/2022-08-01/swagger.json#L803
    ⚠️ 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/stable/2022-08-01/swagger.json#L806
    ⚠️ 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/stable/2022-08-01/swagger.json#L811
    ⚠️ 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/stable/2022-08-01/swagger.json#L815
    ⚠️ 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/stable/2022-08-01/swagger.json#L819
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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
    ⚠️ R4021 - DescriptionAndTitleMissing '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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 11, 2022

    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 53b1aff. SDK Automation 14.0.0
      warn	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 --use=@microsoft.azure/autorest.csharp@2.3.82 --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 53b1aff. SDK Automation 14.0.0
      command	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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️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]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 53b1aff. SDK Automation 14.0.0
      command	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 53b1aff. SDK Automation 14.0.0
      command	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 53b1aff. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN 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
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 53b1aff. SDK Automation 14.0.0
      command	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
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 11, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-nginx https://apiview.dev/Assemblies/Review/f6c92300881c4f1c86bfe30865c8c208
    Java azure-resourcemanager-nginx https://apiview.dev/Assemblies/Review/087a614491bc4bf79e66ad0c9acae02e
    JavaScript @azure/arm-nginx https://apiview.dev/Assemblies/Review/2ae873f275a94757b78035bd5e0f7319

    @limingu
    Copy link
    Member Author

    limingu commented Aug 11, 2022

    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.

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @openapi-workflow-bot
    Copy link

    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.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 16, 2022
    @openapi-workflow-bot
    Copy link

    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).

    @limingu limingu removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 16, 2022
    @limingu
    Copy link
    Member Author

    limingu commented Aug 17, 2022

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants