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

first commit for new api version #20942

Merged
merged 5 commits into from
Oct 8, 2022
Merged

Conversation

kukulkarni1
Copy link
Contributor

ARM API Information (Control Plane)

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. November 2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. November 2022
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 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
      -[x] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @kukulkarni1 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 Sep 29, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 22 Errors, 65 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.7)] new version base version
    AzureTrafficCollector.json 2022-11-01(0836411) 2022-08-01(main)
    AzureTrafficCollector.json 2022-11-01(0836411) 2021-09-01-preview(main)

    The following breaking changes are detected by comparison with the latest stable version:

    Rule Message
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L640:9
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L588:9
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'properties' renamed or removed?
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L878:7
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L759:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'etag' renamed or removed?
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L878:7
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L759:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'name' renamed or removed?
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L878:7
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L759:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'type' renamed or removed?
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L878:7
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L759:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'location' renamed or removed?
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L878:7
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L759:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'tags' renamed or removed?
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L878:7
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L759:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'systemData' renamed or removed?
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L878:7
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L759:7
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L623:11
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L571:11
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L174:13
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L174:13
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L215:13
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L215:13
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L224:13
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L224:13
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L230:13
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L230:13
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L335:13
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L335:13
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L686:11
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L633:11
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L420:13
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L420:13
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L464:13
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L464:13
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L473:13
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L473:13
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L479:13
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L479:13
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L660:5
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L607:5
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L810:5
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L757:5
    1034 - AddedRequiredProperty The new version has new required property 'location' that was not found in the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L831:5
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L778:5
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L642:11
    Old: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L590:11


    The following breaking changes are detected by comparison with the latest preview version:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L45:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L45:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L81:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L81:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L120:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L120:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L157:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L157:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L197:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L197:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L257:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L257:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L309:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L309:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L360:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L360:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L400:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L400:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L443:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L443:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L506:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L506:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L1072:5
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L1025:5
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L45:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L81:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L120:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L157:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L197:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L257:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L309:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L360:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L400:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L443:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L506:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-09-01-preview' from the old version.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L1072:5
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L1025:5
    ⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L45:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L45:9
    ⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L81:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L81:9
    ⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L120:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L120:9
    ⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L157:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L157:9
    ⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L197:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L197:9
    ⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L257:9
    Old: Microsoft.NetworkFunction/preview/2021-09-01-preview/AzureTrafficCollector.json#L257:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 3 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-11-01 package-2022-11-01(0836411) default(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ⚠️ R3027 - TrackedResourceListByResourceGroup The tracked resource, 'AzureTrafficCollector', must have a list by resource group operation.(This rule does not apply for tenant level resources.)
    Location: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L660
    ⚠️ R4002 - LocationMustHaveXmsMutability Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'TrackedResource'
    Location: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L604
    ⚠️ R4002 - LocationMustHaveXmsMutability Property 'location' must have ''x-ms-mutability':['read', 'create']' extension defined. Resource Model: 'TrackedResource'
    Location: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L604


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'collectorPolicies' with immediate parent 'AzureTrafficCollector', must have a list by immediate parent operation.
    Location: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L810
    ⚠️ 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: Microsoft.NetworkFunction/stable/2022-11-01/AzureTrafficCollector.json#L989
    ️️✔️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 'Microsoft.NetworkFunction' for api version '2022-11-01'. The supported api-versions are '2021-09-01-preview,
    2022-05-01,
    2022-08-01,
    2021-08-01-preview'."
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️⚠️~[Staging] TrafficValidation: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️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/08364119d684b938c28c69ce54420d80cf3c007c/specification/networkfunction/resource-manager/readme.md#tag-package-2022-11-01">networkfunction/resource-manager/readme.md#package-2022-11-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.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 29, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/networkfunction/armnetworkfunction - 2.0.0
    +	Struct `CloudErrorBody` has been removed
    +	Struct `CloudError` has been removed
    +	Struct `CollectorPolicySystemData` has been removed
    +	Type of `AzureTrafficCollectorPropertiesFormat.CollectorPolicies` has been changed from `[]*CollectorPolicy` to `[]*ResourceReference`
    +	Type of `CollectorPolicy.SystemData` has been changed from `*CollectorPolicySystemData` to `*TrackedResourceSystemData`

    azure-sdk-for-js - @azure/arm-networkfunction - 2.0.0
    +	Interface AzureTrafficCollectorsCreateOrUpdateOptionalParams no longer has parameter collectorPolicies
    +	Interface AzureTrafficCollectorsCreateOrUpdateOptionalParams no longer has parameter location
    +	Interface CollectorPolicy no longer has parameter systemData
    +	Operation AzureTrafficCollectors.beginCreateOrUpdate has a new signature
    +	Operation AzureTrafficCollectors.beginCreateOrUpdateAndWait has a new signature
    +	Operation CollectorPolicies.beginCreateOrUpdate has a new signature
    +	Operation CollectorPolicies.beginCreateOrUpdateAndWait has a new signature
    +	Parameter location of interface TrackedResource is now required
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 5ef9346. 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
    • ️✔️sdk/resourcemanager/networkfunction/armnetworkfunction [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `CollectorPolicy.SystemData` has been changed from `*CollectorPolicySystemData` to `*TrackedResourceSystemData`
      info	[Changelog] - Type of `AzureTrafficCollectorPropertiesFormat.CollectorPolicies` has been changed from `[]*CollectorPolicy` to `[]*ResourceReference`
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog] - Struct `CloudErrorBody` has been removed
      info	[Changelog] - Struct `CollectorPolicySystemData` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `APIVersionParameterTwoThousandTwentyTwo0801`
      info	[Changelog] - New const `APIVersionParameterTwoThousandTwentyTwo0501`
      info	[Changelog] - New const `APIVersionParameterTwoThousandTwentyTwo1101`
      info	[Changelog] - New type alias `APIVersionParameter`
      info	[Changelog] - New function `PossibleAPIVersionParameterValues() []APIVersionParameter`
      info	[Changelog] - New function `*CollectorPoliciesClient.UpdateTags(context.Context, string, string, string, TagsObject, *CollectorPoliciesClientUpdateTagsOptions) (CollectorPoliciesClientUpdateTagsResponse, error)`
      info	[Changelog] - New struct `CollectorPoliciesClientUpdateTagsOptions`
      info	[Changelog] - New struct `CollectorPoliciesClientUpdateTagsResponse`
      info	[Changelog] - New field `Location` in struct `CollectorPolicy`
      info	[Changelog] - New field `Tags` in struct `CollectorPolicy`
      info	[Changelog]
      info	[Changelog] Total 8 breaking change(s), 11 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 5ef9346. 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-networkfunction [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation CollectorPolicies.updateTags
      info	[Changelog]   - Added Interface CollectorPoliciesUpdateTagsOptionalParams
      info	[Changelog]   - Added Type Alias ApiVersionParameter
      info	[Changelog]   - Added Type Alias CollectorPoliciesUpdateTagsResponse
      info	[Changelog]   - Interface CollectorPoliciesCreateOrUpdateOptionalParams has a new optional parameter tags
      info	[Changelog]   - Added Enum KnownApiVersionParameter
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Operation AzureTrafficCollectors.beginCreateOrUpdate has a new signature
      info	[Changelog]   - Operation AzureTrafficCollectors.beginCreateOrUpdateAndWait has a new signature
      info	[Changelog]   - Operation CollectorPolicies.beginCreateOrUpdate has a new signature
      info	[Changelog]   - Operation CollectorPolicies.beginCreateOrUpdateAndWait has a new signature
      info	[Changelog]   - Interface AzureTrafficCollectorsCreateOrUpdateOptionalParams no longer has parameter collectorPolicies
      info	[Changelog]   - Interface AzureTrafficCollectorsCreateOrUpdateOptionalParams no longer has parameter location
      info	[Changelog]   - Interface CollectorPolicy no longer has parameter systemData
      info	[Changelog]   - Parameter location of interface TrackedResource is now required
    Posted by Swagger Pipeline | How to fix these errors?

    @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 Sep 29, 2022
    @openapi-workflow-bot
    Copy link

    Hi, @kukulkarni1 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 29, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/networkfunction/armnetworkfunction Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Python track2_azure-mgmt-networkfunction Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-networkfunction Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-networkfunction Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @openapi-workflow-bot
    Copy link

    Hi @kukulkarni1, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

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

    @AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Sep 30, 2022
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Oct 3, 2022
    @kukulkarni1
    Copy link
    Contributor Author

    API readiness check stage should get resolved once ARM manifest changes are rolled out. ETA is end of October.

    "description": "Azure Subscription ID.",
    "required": true,
    "type": "string"
    },
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    nit, you could refactor these away by using references to common-types parameter definitions. A lot of services do that with apiVersionParameter too.

    }
    }
    },
    "SystemData": {
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    SystemData

    You could refactor these away by using references to common-types' SystemData definitions. That helps ensure all services define them consistently and makes reviewing much easier.

    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Maybe I should help out by sending a refactor PR. :)

    Copy link
    Member

    @TimLovellSmith TimLovellSmith left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    :shipit:

    @TimLovellSmith TimLovellSmith added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 4, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 4, 2022
    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 ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-FixRequiredOnFailure ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants