Fixing TSP for Validation Issues #24225

malpaniHMC · 2023-05-31T00:02:09Z

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-31T00:02:12Z

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-31T00:02:12Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

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

️️✔️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
default	default(851a31d)	default(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]

Rule	Message
`❌` InConsistentSwagger	"details":"The generated swagger file 2023-05-01-preview/TrafficController.json from typespec specification/servicenetworking/ServiceNetworking.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log."

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

Validation passes for Summary.

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

openapi-pipeline-app · 2023-05-31T00:02:13Z

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 4732753. 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.
warn		specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
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.zip
- azure_mgmt_servicenetworking-1.0.0b1-py3-none-any.whl
```
info	[Changelog]
```

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

️✔️Succeeded [Logs]Release - Generate from 4732753. 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
warn		specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
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-31T00:02:14Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/servicenetworking/armservicenetworking	There is no API change compared with the previous version

init

00f0f2a

malpaniHMC requested review from markcowl and mikeharder May 31, 2023 00:02

openapi-assignment-bot bot assigned zedy-wj May 31, 2023

perfect match

851a31d

azure-sdk mentioned this pull request May 31, 2023

[AutoPR sdk/resourcemanager/servicenetworking/armservicenetworking] Fixing TSP for Validation Issues azure-sdk/azure-sdk-for-go#5916

Closed

AzureRestAPISpecReview added the resource-manager label May 31, 2023

azure-sdk mentioned this pull request May 31, 2023

[AutoPR track2_azure-mgmt-servicenetworking] Fixing TSP for Validation Issues azure-sdk/azure-sdk-for-python#3707

Closed

mikeharder approved these changes May 31, 2023

View reviewed changes

mikeharder merged commit 4732753 into main May 31, 2023

mikeharder deleted the shmalpani/tsp-fix-2023-05 branch May 31, 2023 01:08

This was referenced May 31, 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 mentioned this pull request Jun 2, 2023

Tsp next 045 #24265

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixing TSP for Validation Issues #24225

Fixing TSP for Validation Issues #24225

malpaniHMC commented May 31, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 31, 2023

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

edited

Loading

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

edited

Loading

Breaking Changes Tracking

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

edited

Loading

Fixing TSP for Validation Issues #24225

Fixing TSP for Validation Issues #24225

Conversation

malpaniHMC commented May 31, 2023 • edited Loading

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 31, 2023

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

Swagger Validation Report

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

Swagger Generation Artifacts

Breaking Changes Tracking

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

Generated ApiView

malpaniHMC commented May 31, 2023 •

edited

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading