Skip to content

Conversation

mwesigwaguma
Copy link
Contributor

@mwesigwaguma mwesigwaguma commented Oct 25, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 25, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 25, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
application.json 2021-06-01(972c19d) 2021-06-01(main)
cluster.json 2021-06-01(972c19d) 2021-06-01(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.6) new version base version
package-2021-06 package-2021-06(972c19d) package-2021-06(main)

The following errors/warnings exist before current PR submission:

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

Rule Message
ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L37
ResourceNameRestriction The resource name parameter 'applicationTypeName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L37
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L82
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L167
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L176
ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L182
ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L228
ResourceNameRestriction The resource name parameter 'applicationTypeName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L228
ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L276
ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L276
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L276
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L320
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L329
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L368
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L377
ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L383
ResourceNameRestriction The resource name parameter 'applicationTypeName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L383
ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L432
ResourceNameRestriction The resource name parameter 'applicationName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L432
ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L477
ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L477
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L477
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L524
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L533
PatchResponseCodes Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L538
PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L561
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L579
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L588
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L624
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.ServiceFabric/stable/2021-06-01/application.json#L633
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 25, 2023

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/servicefabric/armservicefabric - Approved - 2.0.0
+	Operation `*ApplicationTypeVersionsClient.List` has supported pagination, use `*ApplicationTypeVersionsClient.NewListPager` instead.
+	Operation `*ApplicationTypesClient.List` has supported pagination, use `*ApplicationTypesClient.NewListPager` instead.
+	Operation `*ApplicationsClient.List` has supported pagination, use `*ApplicationsClient.NewListPager` instead.
+	Operation `*ClustersClient.ListByResourceGroup` has supported pagination, use `*ClustersClient.NewListByResourceGroupPager` instead.
+	Operation `*ClustersClient.List` has supported pagination, use `*ClustersClient.NewListPager` instead.
+	Operation `*ServicesClient.List` has supported pagination, use `*ServicesClient.NewListPager` instead.

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 6963bf0. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️track2_azure-mgmt-servicefabric [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added model ClusterVersionsEnvironment
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 6963bf0. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-servicefabric [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 6963bf0. 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/servicefabric/armservicefabric [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Operation `*ApplicationTypeVersionsClient.List` has supported pagination, use `*ApplicationTypeVersionsClient.NewListPager` instead.
    info	[Changelog] - Operation `*ApplicationTypesClient.List` has supported pagination, use `*ApplicationTypesClient.NewListPager` instead.
    info	[Changelog] - Operation `*ApplicationsClient.List` has supported pagination, use `*ApplicationsClient.NewListPager` instead.
    info	[Changelog] - Operation `*ClustersClient.List` has supported pagination, use `*ClustersClient.NewListPager` instead.
    info	[Changelog] - Operation `*ClustersClient.ListByResourceGroup` has supported pagination, use `*ClustersClient.NewListByResourceGroupPager` instead.
    info	[Changelog] - Operation `*ServicesClient.List` has supported pagination, use `*ServicesClient.NewListPager` instead.
    info	[Changelog]
    info	[Changelog] Total 6 breaking change(s), 0 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 6963bf0. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh]
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.2
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.2>
    cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  • ️✔️servicefabric [View full logs]  [Release Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from 6963bf0. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ⚠️Az.servicefabric.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.servicefabric.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 25, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/servicefabric/armservicefabric https://apiview.dev/Assemblies/Review/0742443e04cb4f688711e91d4706a5c1
.Net Azure.ResourceManager.ServiceFabric There is no API change compared with the previous version
Java azure-resourcemanager-servicefabric https://apiview.dev/Assemblies/Review/8d54aa5f915a4249b97d7c157be6ee3c

@ms-henglu ms-henglu added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 25, 2023
@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 25, 2023
@mwesigwaguma
Copy link
Contributor Author

@raych1 raych1 added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Nov 1, 2023
@mwesigwaguma
Copy link
Contributor Author

/pr RequestMerge

@rkmanda rkmanda merged commit 6963bf0 into Azure:main Nov 1, 2023
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
…turn resources (#26369)

* update metadata with nextlink

* adding missing property to applicationTypeResourceList schema

* adding missing property to applicationTypeResourceList schema
zman-ms pushed a commit that referenced this pull request Jan 10, 2024
…turn resources (#26369)

* update metadata with nextlink

* adding missing property to applicationTypeResourceList schema

* adding missing property to applicationTypeResourceList schema
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 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