Avoid Partial Pattern Matches #24081

malpaniHMC · 2023-05-19T23:06:03Z

ARM API Information (Control Plane)

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
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):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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

ARM API Review Checklist

Applicability: ⚠️

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
  -[ ] 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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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 · 2023-05-19T23:06:06Z

Hi, @malpaniHMC 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 · 2023-05-19T23:06:07Z

Swagger Validation Report

️❌BreakingChange: 22 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
TrafficController.json	2023-05-01-preview(cd1cdc7)	2023-05-01-preview(main)

Rule	Message
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L190:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L190:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L235:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L235:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L306:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L306:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L360:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L360:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L425:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L425:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L475:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L475:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L483:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L483:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L528:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L528:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L536:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L536:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L607:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L607:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L615:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L615:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L669:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L669:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L677:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L677:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L742:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L742:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L792:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L792:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L800:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L800:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L845:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L845:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L853:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L853:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L924:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L924:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L932:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L932:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L986:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L986:11
`❌` 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L994:11 Old: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L994:11

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.2)	new version	base version
package-2023-05-01-preview	package-2023-05-01-preview(cd1cdc7)	package-2023-05-01-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L253
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L554
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L871
⚠️ ProvisioningStateSpecifiedForLRODelete	200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L370
⚠️ ProvisioningStateSpecifiedForLRODelete	200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L687
⚠️ ProvisioningStateSpecifiedForLRODelete	200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L1004
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L1132
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L1247

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

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

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

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️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.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-05-19T23:06:08Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 5d9660b. 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]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.7
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.7` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-servicenetworking [View full logs] [Release SDK Changes]
- azure_mgmt_servicenetworking-1.0.0b1-py3-none-any.whl
- azure-mgmt-servicenetworking-1.0.0b1.zip
```
info	[Changelog]
```

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 5d9660b. 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/servicenetworking/armservicenetworking [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-05-19T23:06:09Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/servicenetworking/armservicenetworking	https://apiview.dev/Assemblies/Review/b790bf2517394184b6126daf71aece26

openapi-workflow-bot · 2023-05-19T23:12:06Z

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

JackTn · 2023-05-22T05:50:24Z

@malpaniHMC can you fix or explain the breaking change that why cause ConstraintChanged happend

JackTn · 2023-05-22T05:51:17Z

@msyyc @tadelesh help to approve sdk-breaking-for python/go , Thanks

malpaniHMC · 2023-05-22T17:45:49Z

Hi @JackTn, our service is still in the private preview stage and the breaking change is not a problem for us at the moment. We realized that we wanted our service to accept a more limited range of inputs for resource names.

JackTn · 2023-05-23T03:09:24Z

@malpaniHMC

Hi @JackTn, our service is still in the private preview stage and the breaking change is not a problem for us at the moment. We realized that we wanted our service to accept a more limited range of inputs for resource names.

@JeffreyRichter can you approve this breaking change ?

msyyc · 2023-05-24T01:33:27Z

/azp run

azure-pipelines · 2023-05-24T01:33:36Z

Azure Pipelines successfully started running 1 pipeline(s).

JackTn · 2023-05-25T08:38:11Z

@malpaniHMC pls resolve conflicts and do you need to merge this pr now ?

malpaniHMC · 2023-05-25T18:06:21Z

@JackTn I have resolved the merge conflicts. Yes, I would like the PR to be merged now.

JackTn · 2023-05-26T02:07:50Z

@JackTn I have resolved the merge conflicts. Yes, I would like the PR to be merged now.

@msyyc take a look on this pr and help to merge it, Thanks

- Swagger was accidentally updated manually in #24081

updating pattern to avoid partial matches

32a2bdb

openapi-assignment-bot bot assigned JackTn May 19, 2023

azure-sdk mentioned this pull request May 19, 2023

[AutoPR sdk/resourcemanager/servicenetworking/armservicenetworking] Avoid Partial Pattern Matches azure-sdk/azure-sdk-for-go#5782

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label May 19, 2023

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager labels May 19, 2023

azure-sdk mentioned this pull request May 19, 2023

[AutoPR track2_azure-mgmt-servicenetworking] Avoid Partial Pattern Matches azure-sdk/azure-sdk-for-python#3621

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label May 19, 2023

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label May 23, 2023

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 23, 2023

msyyc added the Approved-SdkBreakingChange-Python label May 24, 2023

tadelesh removed CI-BreakingChange-Go Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go labels May 25, 2023

Merge branch 'main' into shmalpani/2023-05-pattern

cd1cdc7

openapi-pipeline-app bot added Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go CI-BreakingChange-Go labels May 25, 2023

JackTn added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 26, 2023

msyyc approved these changes May 30, 2023

View reviewed changes

msyyc merged commit 5d9660b into main May 30, 2023

msyyc deleted the shmalpani/2023-05-pattern branch May 30, 2023 05:12

This was referenced May 30, 2023

[ReleasePR sdk/resourcemanager/servicenetworking/armservicenetworking] AGC Version 2023-11-01 Azure/azure-sdk-for-go#19764

Closed

[ReleasePR track2_azure-mgmt-servicenetworking] AGC Version 2023-11-01 Azure/azure-sdk-for-python#28131

Closed

mikeharder pushed a commit that referenced this pull request May 31, 2023

[ServiceNetworking.Management] Update TypeSpec to match Swagger (#24225)

4732753

- Swagger was accidentally updated manually in #24081

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Avoid Partial Pattern Matches #24081

Avoid Partial Pattern Matches #24081

malpaniHMC commented May 19, 2023

openapi-workflow-bot bot commented May 19, 2023

openapi-pipeline-app bot commented May 19, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 19, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented May 19, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 19, 2023

JackTn commented May 22, 2023

JackTn commented May 22, 2023

malpaniHMC commented May 22, 2023 •

edited

Loading

JackTn commented May 23, 2023

msyyc commented May 24, 2023

azure-pipelines bot commented May 24, 2023

JackTn commented May 25, 2023

malpaniHMC commented May 25, 2023

JackTn commented May 26, 2023

Avoid Partial Pattern Matches #24081

Avoid Partial Pattern Matches #24081

Conversation

malpaniHMC commented May 19, 2023

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 19, 2023

openapi-pipeline-app bot commented May 19, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 19, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented May 19, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented May 19, 2023

JackTn commented May 22, 2023

JackTn commented May 22, 2023

malpaniHMC commented May 22, 2023 • edited Loading

JackTn commented May 23, 2023

msyyc commented May 24, 2023

azure-pipelines bot commented May 24, 2023

JackTn commented May 25, 2023

malpaniHMC commented May 25, 2023

JackTn commented May 26, 2023

openapi-pipeline-app bot commented May 19, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 19, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 19, 2023 •

edited

Loading

malpaniHMC commented May 22, 2023 •

edited

Loading