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

Network function #19888

Merged
merged 22 commits into from
Jul 29, 2022
Merged

Network function #19888

merged 22 commits into from
Jul 29, 2022

Conversation

kukulkarni1
Copy link
Contributor

@kukulkarni1 kukulkarni1 commented Jul 21, 2022

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. - Aug 2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. - July 2022
  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.

@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 Jul 21, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 62 Warnings warning [Detail]
    compared swaggers (via Oad v0.9.6)] new version base version
    AzureTrafficCollector.json 2022-08-01(2be0f35) 2022-05-01(main)
    AzureTrafficCollector.json 2022-08-01(2be0f35) 2021-09-01-preview(main)

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

    Rule Message
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L45:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L45:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L81:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L81:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L120:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L120:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L157:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L157:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L197:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L197:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L257:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L257:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L309:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L309:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L360:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L360:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L400:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L400:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L443:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L443:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L506:9
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L506:9
    ⚠️ 1016 - ConstantStatusHasChanged The 'constant' status changed from the old version to the new.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L1016:5
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L1025:5
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L590:11
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L590:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L633:11
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L633:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L420:13
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L420:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L464:13
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L464:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L473:13
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L473:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L479:13
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L479:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.NetworkFunction/stable/2022-08-01/AzureTrafficCollector.json#L757:5
    Old: Microsoft.NetworkFunction/stable/2022-05-01/AzureTrafficCollector.json#L757:5


    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-08-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-08-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-08-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-08-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-08-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-08-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-08-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-08-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-08-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-08-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-08-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-08-01/AzureTrafficCollector.json#L1016: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-08-01/AzureTrafficCollector.json#L1016: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-08-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-08-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-08-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-08-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-08-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-08-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: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-08-01 package-2022-08-01(2be0f35) default(main)

    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-08-01/AzureTrafficCollector.json#L757
    ⚠️ 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-08-01/AzureTrafficCollector.json#L933
    ️️✔️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: undefined,
    message: undefined"
    ️️✔️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/2be0f35303c3d0ec22e8fec21089a8dd4ccbb2df/specification/networkfunction/resource-manager/readme.md#tag-package-2022-08-01">networkfunction/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 Jul 21, 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 - armnetworkfunction - Approved - 2.0.0
    +	Struct `CollectorPolicySystemData` has been removed
    +	Type of `CollectorPolicy.SystemData` has been changed from `*CollectorPolicySystemData` to `*TrackedResourceSystemData`
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-networkfunction - first release
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1cefdab. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-networkfunction [View full logs]  [Release SDK Changes]
      info	[Changelog]   - Initial Release
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1cefdab. 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
    • ️✔️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] - Struct `CollectorPolicySystemData` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `APIVersionParameterTwoThousandTwentyTwo0501`
      info	[Changelog] - New const `APIVersionParameterTwoThousandTwentyTwo0801`
      info	[Changelog] - New function `PossibleAPIVersionParameterValues() []APIVersionParameter`
      info	[Changelog] - New field `Location` in struct `CollectorPolicy`
      info	[Changelog] - New field `Tags` in struct `CollectorPolicy`
      info	[Changelog]
      info	[Changelog] Total 3 breaking change(s), 4 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1cefdab. 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]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Type Alias ApiVersionParameter
      info	[Changelog]   - Added Type Alias AzureTrafficCollector
      info	[Changelog]   - Added Type Alias CollectorPolicy
      info	[Changelog]   - Added Type Alias TrackedResourceSystemData
      info	[Changelog]   - Interface CollectorPoliciesCreateOrUpdateOptionalParams has a new optional parameter location
      info	[Changelog]   - Interface CollectorPoliciesCreateOrUpdateOptionalParams has a new optional parameter tags
      info	[Changelog]   - Added Enum KnownApiVersionParameter
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    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.

    @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 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @kukulkarni1 kukulkarni1 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 25, 2022
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 25, 2022
    @zizw123
    Copy link

    zizw123 commented Jul 26, 2022

    The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. Can you put the older API version as the base in the first commit, and update it to a new version in later commit? So that reviewers can review the diffs between API version.

    This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version .

    Please remove the "ARMChangesRequested" tag once you have fixed this issue.

    @zizw123 zizw123 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 26, 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 Jul 26, 2022
    @kukulkarni1
    Copy link
    Contributor Author

    The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. Can you put the older API version as the base in the first commit, and update it to a new version in later commit? So that reviewers can review the diffs between API version.

    This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version .

    Please remove the "ARMChangesRequested" tag once you have fixed this issue.

    I have added 1 commit for the old api version (25d9784) and another one for the new api version (2be0f35)

    @kukulkarni1 kukulkarni1 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 26, 2022
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 26, 2022
    @zizw123 zizw123 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 26, 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 Jul 26, 2022
    @tadelesh tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jul 28, 2022
    @msyyc
    Copy link
    Member

    msyyc commented Jul 28, 2022

    Hi @kukulkarni1 when will the new api-version be deployed?
    image

    @kukulkarni1
    Copy link
    Contributor Author

    Hi @kukulkarni1 when will the new api-version be deployed? image

    Hi @msyyc, ETA for the operation that is failing (/providers/Microsoft.NetworkFunction/operations) is Aug 30th. This is the task: https://msazure.visualstudio.com/One/_workitems/edit/14981956/ . However, this part has not been changed in our new swagger. It is part of the ARM API review tasks that we are working on.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants