Skip to content

[Test] Add version stable/2023-11-01 #3110

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

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open

[Test] Add version stable/2023-11-01 #3110

wants to merge 29 commits into from

Conversation

ankhyk
Copy link

@ankhyk ankhyk commented Dec 1, 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. (If API spec is not defined in TypeSpec, the PR should have been generated using 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

raych1 and others added 29 commits September 13, 2023 06:39
* Rename bug.md to bug_report.md

* Create config.yml
[Internal testing] testing openapi-alps PR 510778 - Test 11/14/2023 / 1
[Internal testing] testing openapi-alps PR 510778 - Test 11/14/2023 / 2
[Internal testing] testing openapi-alps PR 510778 - Test 11/15/2023 / 1
[Internal testing] testing openapi-alps PR 511346 - Test 1
Copy link

openapi-pipeline-app-test bot commented Dec 1, 2023

Next Steps to merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes in the generated SDK for go (label: CI-BreakingChange-Go). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).
  • ❌ Your PR has breaking changes in the generated SDK for javascript (label: CI-BreakingChange-JavaScript). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).
  • ❌ The suppressions you added require review. Refer to step 1 in the PR workflow diagram (even if your PR is for data plane, not ARM), or to step 3, depending onthe kind of suppression you did.
  • ❌ The required check named Swagger LintDiff has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

Copy link

openapi-pipeline-app-test bot commented Dec 1, 2023

Swagger Generation Artifacts

️🔄~[NotRequired_Staging] ApiDocPreview inProgress [Detail]
️❌ azure-sdk-for-net-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-java warning [Detail]

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

️❌ azure-powershell failed [Detail]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app-test bot commented Dec 1, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/dataprotection/armdataprotection There is no API change compared with the previous version
Java azure-resourcemanager-dataprotection There is no API change compared with the previous version
JavaScript @azure/arm-dataprotection There is no API change compared with the previous version
Swagger Microsoft.DataProtection There is no API change compared with the previous version

Copy link

openapi-pipeline-app-test bot commented Dec 1, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 22 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
dataprotection.json 2023-11-01(f9f8726) 2023-08-01(main)
dataprotection.json 2023-11-01(f9f8726) 2023-08-01-preview(main)

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

Rule Message
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateForModifyBackup' removed or restructured?
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1369:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/{resourceId}/providers/Microsoft.DataProtection/backupInstances' removed or restructured?
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1965:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}/triggerCancel' removed or restructured?
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2729:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}/generateProgressUrl' removed or restructured?
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2793:5
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CmkKeyVaultProperties' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4089:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CmkKekIdentity' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4089:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'encryptionSettings' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4089:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ValidateForModifyBackupRequest' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4089:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceId' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L8098:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L8427:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'RestrictedVaultName' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L8098:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L8427:3
⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'SecondaryRPs_Fetch' to 'FetchSecondaryRecoveryPoints_List'. This will impact generated code.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1538:7
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1620:7
⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'CrossRegionRestoreJob_Get' to 'FetchCrossRegionRestoreJob_Get'. This will impact generated code.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1762:7
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1851:7
⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'CrossRegionRestoreJobs_List' to 'FetchCrossRegionRestoreJobs_List'. This will impact generated code.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1816:7
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1907:7
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1669:13
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1756:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/types.json#L307:9
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L5805:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/types.json#L282:11
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L6538:11
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1745:13
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1834:13
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L7106:9
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7428:9
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L7111:9
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7432:9
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'encryptionSettings' renamed or removed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L7543:7
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7856:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'sourceDataStoreType' renamed or removed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4343:7
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4575:7
⚠️ 1042 - ChangedParameterOrder The order of parameter 'parameters' was changed.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1825:9
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1915:9
️❌LintDiff: 3 Errors, 3 Warnings failed [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-2023-11 package-2023-11(f9f8726) default(main)

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

Rule Message Related RPC [For API reviewers]
ParametersInPost $filter is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1547
RPC-Post-V1-05
ParametersInPost $skipToken is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1547
RPC-Post-V1-05
ParametersInPost $filter is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1825
RPC-Post-V1-05
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'fetchsecondaryrecoverypoints' in:'FetchSecondaryRecoveryPoints_List'. Consider updating the operationId
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1543
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'fetchcrossregionrestorejob' in:'FetchCrossRegionRestoreJob_Get'. Consider updating the operationId
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1767
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'fetchcrossregionrestorejobs' in:'FetchCrossRegionRestoreJobs_List'. Consider updating the operationId
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1821


The following errors/warnings exist before current PR submission:

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

Rule Message
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L42
LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L64
ParametersOrder The parameters:operationId,location should be kept in the same order as they present in the path.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L64
GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L94
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L307
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L426
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L440
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L467
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L476
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L526
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L532
LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L545
GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L580
OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L740
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L788
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.DataProtection/stable/2023-11-01/dataprotection.json#L860
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L996
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.DataProtection/stable/2023-11-01/dataprotection.json#L1064
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1128
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1139
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1193
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1269
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1345
LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1361
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'BackupInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1366
GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1400
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1400
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1461
PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1880
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1937
️️✔️~[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️~[NotRequired_Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

Hi @keryul! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants