Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger correctness completeness #15693

Merged
merged 5 commits into from
Sep 15, 2021

Conversation

Wistlie
Copy link
Contributor

@Wistlie Wistlie commented Aug 18, 2021

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:

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

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • 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.

@openapi-workflow-bot
Copy link

Hi, @Wistlie 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. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 18, 2021

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 7 Warnings failed [Detail]
    Rule Message
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'provisioningState' in response that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'id' in response that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'type' in response that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'etag' in response that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    ⚠️ 1041 - AddedPropertyInResponse The new version has a new property 'resolvedPrivateLinkServiceLocation' in response that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    ⚠️ 1041 - AddedPropertyInResponse The new version has a new property 'resourceGuid' in response that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    ⚠️ 1041 - AddedPropertyInResponse The new version has a new property 'resourceGuid' in response that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    ⚠️ 1041 - AddedPropertyInResponse The new version has a new property 'type' in response that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    ⚠️ 1045 - AddedOptionalProperty The new version has a new optional property 'resourceGuid' that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    ⚠️ 1045 - AddedOptionalProperty The new version has a new optional property 'resourceGuid' that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    ⚠️ 1045 - AddedOptionalProperty The new version has a new optional property 'type' that was not found in the old version.
    New: azure-rest-api-specs/blob/77984799656bb430ef9f7b662dd0df515c1be22a/null:null:1
    Old: azure-rest-api-specs/blob/main/null:null:1
    ️🔄LintDiff inProgress [Detail]
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️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.
    ️❌[Staging] SDK Track2 Validation: 2 Errors, 0 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    PreCheck/DuplicateSchema "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Duplicate Schema named CloudError -- properties.error.$ref: undefined => "#/components/schemas/schemas:3903" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    PreCheck/DuplicateSchema "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Duplicate Schema named CloudErrorBody -- properties.details.$ref: undefined => "#/components/schemas/schemas:3907" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    💬 AutorestCore/Exception "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-02",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"
    💬 AutorestCore/Exception "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-02",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"


    The following errors/warnings exist before current PR submission:

    Rule Message
    AutorestCore/Exception "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Error: Plugin prechecker reported failure."
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-02",
    "details":"Schema 'ResourceNavigationLink' has a property 'id' that is already declared the parent schema 'SubResource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ResourceNavigationLink"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-02",
    "details":"Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Schema 'NetworkSecurityPerimeter' has a property 'id' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from NetworkSecurityPerimeter"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Schema 'NetworkSecurityPerimeter' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from NetworkSecurityPerimeter"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Schema 'NetworkSecurityPerimeter' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NetworkSecurityPerimeter"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Schema 'PerimeterAssociableResource' has a property 'id' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Schema 'PerimeterAssociableResource' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Schema 'PerimeterAssociableResource' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from PerimeterAssociableResource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Schema 'ResourceNavigationLink' has a property 'id' that is already declared the parent schema 'SubResource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ResourceNavigationLink"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration"
    💬 AutorestCore/Exception "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-02",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    💬 AutorestCore/Exception "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"
    💬 AutorestCore/Exception "readme":"network/resource-manager/readme.md",
    "tag":"package-2021-03-preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 18, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-network - 19.0.0
    ️✔️azure-sdk-for-go - network/mgmt/2021-02-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2020-11-01/network - v57.1.0
    azure-sdk-for-go - network/mgmt/2020-08-01/network - v57.1.0
    +	Field `ExtendedLocation` of struct `VirtualNetworkGatewayPropertiesFormat` has been removed
    +	Field `VirtualNetworkExtendedLocationResourceID` of struct `VirtualNetworkGatewayPropertiesFormat` has been removed
    +	Type of `SubnetPropertiesFormat.PrivateEndpointNetworkPolicies` has been changed from `*string` to `VirtualNetworkPrivateEndpointNetworkPolicies`
    +	Type of `SubnetPropertiesFormat.PrivateLinkServiceNetworkPolicies` has been changed from `*string` to `VirtualNetworkPrivateLinkServiceNetworkPolicies`
    azure-sdk-for-go - network/mgmt/2020-07-01/network - v57.1.0
    +	Field `ExtendedLocation` of struct `VirtualNetworkGatewayPropertiesFormat` has been removed
    +	Field `VirtualNetworkExtendedLocationResourceID` of struct `VirtualNetworkGatewayPropertiesFormat` has been removed
    +	Type of `SubnetPropertiesFormat.PrivateEndpointNetworkPolicies` has been changed from `*string` to `VirtualNetworkPrivateEndpointNetworkPolicies`
    +	Type of `SubnetPropertiesFormat.PrivateLinkServiceNetworkPolicies` has been changed from `*string` to `VirtualNetworkPrivateLinkServiceNetworkPolicies`
    ️✔️azure-sdk-for-go - network/mgmt/2020-06-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2020-05-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2020-04-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2020-03-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2019-12-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2019-11-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2019-09-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2019-08-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2019-07-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2019-06-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2019-04-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2019-02-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2018-12-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2018-11-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2018-10-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2018-08-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2018-07-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2018-06-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2018-04-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2018-02-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2018-01-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2017-11-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2017-10-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2017-09-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2017-08-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2017-06-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2017-03-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2016-12-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2016-09-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2016-06-01/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2016-03-30/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2015-06-15/network - v57.1.0
    ️✔️azure-sdk-for-go - preview/network/mgmt/2015-05-01-preview/network - v57.1.0
    ️✔️azure-sdk-for-go - network/mgmt/2021-03-01/network - v57.1.0
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 54f1c87. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/network/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
    • ️✔️Microsoft.Azure.Management.Network [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 54f1c87. 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
    • ️✔️track2_azure-mgmt-network [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model VirtualHub has a new parameter kind
      info	[Changelog]   - Model ServiceEndpointPolicyDefinition has a new parameter type
      info	[Changelog]   - Model ApplicationGatewayPathRule has a new parameter load_distribution_policy
      info	[Changelog]   - Model ApplicationGatewayRequestRoutingRule has a new parameter load_distribution_policy
      info	[Changelog]   - Model BgpConnection has a new parameter hub_virtual_network_connection
      info	[Changelog]   - Model NetworkVirtualAppliance has a new parameter ssh_public_key
      info	[Changelog]   - Model BastionHost has a new parameter scale_units
      info	[Changelog]   - Model BastionHost has a new parameter enable_shareable_link
      info	[Changelog]   - Model BastionHost has a new parameter enable_file_copy
      info	[Changelog]   - Model BastionHost has a new parameter enable_ip_connect
      info	[Changelog]   - Model BastionHost has a new parameter disable_copy_paste
      info	[Changelog]   - Model BastionHost has a new parameter enable_tunneling
      info	[Changelog]   - Model PrivateEndpoint has a new parameter application_security_groups
      info	[Changelog]   - Model PrivateEndpoint has a new parameter custom_network_interface_name
      info	[Changelog]   - Model PrivateEndpoint has a new parameter ip_configurations
      info	[Changelog]   - Model ServiceTagInformation has a new parameter service_tag_change_number
      info	[Changelog]   - Model FirewallPolicy has a new parameter explicit_proxy_settings
      info	[Changelog]   - Model FirewallPolicy has a new parameter sql
      info	[Changelog]   - Model ApplicationGateway has a new parameter global_configuration
      info	[Changelog]   - Model ApplicationGateway has a new parameter load_distribution_policies
      info	[Changelog]   - Model DscpConfiguration has a new parameter qos_definition_collection
      info	[Changelog]   - Model ApplicationGatewayUrlPathMap has a new parameter default_load_distribution_policy
      info	[Changelog]   - Model InboundNatRule has a new parameter backend_address_pool
      info	[Changelog]   - Model InboundNatRule has a new parameter frontend_port_range_end
      info	[Changelog]   - Model InboundNatRule has a new parameter frontend_port_range_start
      info	[Changelog]   - Model ServiceEndpointPolicy has a new parameter service_alias
      info	[Changelog]   - Model ServiceEndpointPolicy has a new parameter contextual_service_endpoint_policies
      info	[Changelog]   - Model VnetRoute has a new parameter bgp_connections
      info	[Changelog]   - Model VpnGateway has a new parameter enable_bgp_route_translation_for_nat
      info	[Changelog]   - Added operation BastionHostsOperations.begin_update_tags
      info	[Changelog]   - Added operation group ServiceTagInformationOperations
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 54f1c87. SDK Automation 14.0.0
      command	./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
      cmderr	[generate.py] 2021-09-15 02:35:19 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-network-generated"
      cmderr	[generate.py] 2021-09-15 02:35:19 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-09-15 02:35:19 INFO autorest --version=3.6.0 --use=@autorest/java@4.0.37 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/network/azure-resourcemanager-network-generated --java.namespace=com.azure.resourcemanager.network.generated   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/network/resource-manager/readme.md
      cmderr	[generate.py] 2021-09-15 02:37:10 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-09-15 02:37:10 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-09-15 02:37:10 INFO [POM][Skip] pom already has module azure-resourcemanager-network-generated
      cmderr	[generate.py] 2021-09-15 02:37:10 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-09-15 02:37:10 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-09-15 02:37:10 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-network-generated [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-09-15 02:41:19 DEBUG Got artifact_id: azure-resourcemanager-network-generated
      cmderr	[Inst] 2021-09-15 02:41:19 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-09-15 02:41:19 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-09-15 02:41:19 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-09-15 02:41:19 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-09-15 02:41:19 DEBUG Match jar package: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-09-15 02:41:19 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15693/azure-sdk-for-java/azure-resourcemanager-network-generated/azure-resourcemanager-network-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-network-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-network-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-network-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 54f1c87. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️network/mgmt/2021-03-01/network [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2021-02-01/network [View full logs
      Only show 4 items here, please refer to log for details.
      info	[Changelog] - New field `ProvisioningState` in struct `PrivateDNSZonePropertiesFormat`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 6 additive change(s).
      info	[Changelog]
    • ️✔️network/mgmt/2020-11-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2020-08-01/network [View full logsBreaking Change Detected
      Only show 4 items here, please refer to log for details.
      info	[Changelog] - New field `Type` in struct `VirtualNetworkPeering`
      info	[Changelog]
      info	[Changelog] Total 2 breaking change(s), 35 additive change(s).
      info	[Changelog]
    • ️✔️network/mgmt/2020-07-01/network [View full logsBreaking Change Detected
      Only show 4 items here, please refer to log for details.
      info	[Changelog] - New field `DisplayName` in struct `AvailablePrivateEndpointType`
      info	[Changelog]
      info	[Changelog] Total 2 breaking change(s), 27 additive change(s).
      info	[Changelog]
    • ️✔️network/mgmt/2020-06-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2020-05-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2020-04-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2020-03-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2019-12-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2019-11-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2019-09-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2019-08-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2019-07-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2019-06-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2019-04-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2019-02-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2018-12-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2018-11-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2018-10-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2018-08-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2018-07-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2018-06-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2018-04-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2018-02-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2018-01-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2017-11-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2017-10-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2017-09-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2017-08-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2017-06-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2017-03-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2016-12-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2016-09-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2016-06-01/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2016-03-30/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️network/mgmt/2015-06-15/network [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/network/mgmt/2015-05-01-preview/network [View full logs
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 54f1c87. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/network/resource-manager/readme.md
    • ️✔️@azure/arm-network [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/networkManagementClient.js → ./dist/arm-network.js...
      cmderr	[npmPack] created ./dist/arm-network.js in 3.1s
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 54f1c87. 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]  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
      warn	No file changes detected after generation
      warn	Skip detect changed packages
    Posted by Swagger Pipeline | How to fix these errors?

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

    @lirenhe
    Copy link
    Member

    lirenhe commented Aug 20, 2021

    The PR contains breaking change, please follow the process to get it reviewed

    @lirenhe lirenhe added the Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Aug 20, 2021
    @jianyexi
    Copy link
    Contributor

    jianyexi commented Sep 9, 2021

    @Wistlie the breaking change report contains some invalid url that seems a tool's bug, but the error messages are correct . Currently adding optional properties requires a new api version , if you want to fix it in an existing version , you need to go through the breaking change review

    @openapi-workflow-bot
    Copy link

    Hi @Wistlie, 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.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 13, 2021
    @lirenhe
    Copy link
    Member

    lirenhe commented Sep 15, 2021

    The duplicate schema is not related to this PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go FixS360 Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants