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.

Sign up for GitHub

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

Jump to bottom

[Hub Generated] Review request for Microsoft.DataProtection to add version preview/2023-08-01-preview #25967

Merged
merged 17 commits into from
Nov 2, 2023
Merged

[Hub Generated] Review request for Microsoft.DataProtection to add version preview/2023-08-01-preview #25967

merged 17 commits into from
Nov 2, 2023

Conversation

amchandn
Copy link
Contributor

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

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, per this wiki doc.)
  • 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 Sep 26, 2023 •
edited
Loading

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 Sep 26, 2023 •
edited
Loading

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
dataprotection.json 2023-08-01-preview(8b813e9) 2023-05-01(main)
dataprotection.json 2023-08-01-preview(8b813e9) 2023-06-01-preview(main)
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️⚠️LintDiff: 10 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-preview-2023-08 package-preview-2023-08(8b813e9) default(main)

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

Rule Message Related RPC [For API reviewers]
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1381
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1384
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1387
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2741
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2744
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2747
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2805
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2808
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2811
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7350


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/preview/2023-08-01-preview/dataprotection.json#L42
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L64
❌ ParametersOrder The parameters:operationId,location should be kept in the same order as they present in the path.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L64
❌ GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L94
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/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/preview/2023-08-01-preview/dataprotection.json#L429
❌ 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/preview/2023-08-01-preview/dataprotection.json#L446
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L473
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L482
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L532
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L538
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L554
❌ GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L589
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L749
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L797
❌ 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/preview/2023-08-01-preview/dataprotection.json#L869
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1005
❌ 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/preview/2023-08-01-preview/dataprotection.json#L1073
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1137
❌ 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/preview/2023-08-01-preview/dataprotection.json#L1148
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1202
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1278
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1354
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1443
❌ 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/preview/2023-08-01-preview/dataprotection.json#L1448
❌ GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1482
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1482
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1543
❌ ParametersInPost $filter is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1629
❌ ParametersInPost $skipToken is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1629
️️✔️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 Sep 26, 2023 •
edited
Loading

Swagger Generation Artifacts

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

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

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

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

️❌ 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?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 26, 2023 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/dataprotection/armdataprotection https://apiview.dev/Assemblies/Review/f3cde38f552849ada07867b8c2c23c77
Java azure-resourcemanager-dataprotection https://apiview.dev/Assemblies/Review/8481d2ace6d24c7494d70d4969f589b2
JavaScript @azure/arm-dataprotection https://apiview.dev/Assemblies/Review/84fdfc73995a4da5a6a480588a12e79d

@azure-sdk azure-sdk mentioned this pull request Sep 26, 2023
Closed
This was referenced Sep 26, 2023
Closed
Closed
Closed
Closed
@dishantmunjal dishantmunjal added NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR DoNotMerge <valid label in PR review process> use to hold merge after approval labels Sep 26, 2023
@chandrasekarendran
JobCancel & Job InProgress changes
e3ebac3
@soumyapattnaik
vault tier changes aks (#25972)
477be7a
@nickpacificomsft
Add is isPartialRP boolean to AzureBackupDiscreteRecoveryPoint and ex…
4dff4a1 
…amples (#25974)

* Add is ispartialrp to AzureBackupDiscreteRecoveryPoint and examples

* Fix prettier issues in examples
@chandrasekarendran chandrasekarendran marked this pull request as ready for review September 29, 2023 05:47
@chandrasekarendran chandrasekarendran removed the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label Sep 29, 2023
@openapi-pipeline-app openapi-pipeline-app bot added the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label Sep 29, 2023
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 29, 2023
@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Sep 29, 2023
@raosuhas
Copy link

raosuhas commented Sep 29, 2023 •
edited by sjanamma
Loading 

      "type": "string"

Should this be marked with x-ms-secret ? #Resolved

Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json:4787 in 91a2f30. [](commit_id = 91a2f30, deletion_comment = False)

@raosuhas
Copy link

raosuhas commented Sep 29, 2023 •
edited by sjanamma
Loading 

    },

ARM recommends enums over booleans for future proof APIs.

replace boolean/switch properties with a more meaningful enum whenever possible.
A boolean will forever have two valid values (true or false). A string enum type is always preferred. Also, properties should always provide better values just than True and False. For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType]. Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].
Note: do NOT define a 'boolean enum' with two values 'True and False'. This might be easier to 'extend' in terms of types, but semantically its cofusing, and no better than a boolean. #Resolved

Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json:7472 in 91a2f30. [](commit_id = 91a2f30, deletion_comment = False)

@raych1
Copy link
Member

raych1 commented Oct 12, 2023

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@openapi-pipeline-app
Copy link

Swagger Validation Report

️🔄BreakingChange inProgress [Detail]
️🔄Breaking Change(Cross-Version) inProgress [Detail]
️⌛CredScan pending [Detail]
️🔄LintDiff inProgress [Detail]
️️✔️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 pending [Detail]
️🔄PrettierCheck inProgress [Detail]
️️✔️SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️🔄Lint(RPaaS) inProgress [Detail]
️⌛PR Summary pending [Detail]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@dishantmunjal
Copy link
Contributor

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@dishantmunjal dishantmunjal added MergeRequested and removed DoNotMerge <valid label in PR review process> use to hold merge after approval labels Nov 2, 2023
@dishantmunjal
Copy link
Contributor

/pr RequestMerge

@rkmanda rkmanda merged commit 9b96120 into main Nov 2, 2023
28 of 31 checks passed
@rkmanda rkmanda deleted the amchandn-dataprotection-Microsoft.DataProtection-2023-08-01-preview branch November 2, 2023 18:53
@openapi-pipeline-app openapi-pipeline-app
Copy link

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

@azure-sdk azure-sdk mentioned this pull request Nov 2, 2023
Closed
This was referenced Nov 2, 2023
Closed
Closed
This was referenced Nov 2, 2023
Closed
Closed
jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
@amchandn @dishantmunjal
@chandrasekarendran @soumyapattnaik @nickpacificomsft @asmitt @jnlycklama
[Hub Generated] Review request for Microsoft.DataProtection to add ve…
69cb55f 
…rsion preview/2023-08-01-preview (#25967)

* Adds base for updating Microsoft.DataProtection from version preview/2023-06-01-preview to version 2023-08-01-preview

* Updates readme

* Updates API version in new specs and examples

* Re-Validate API Swagger Changes

* JobCancel & Job InProgress changes

* vault tier changes aks (#25972)

* Add is isPartialRP boolean to AzureBackupDiscreteRecoveryPoint and examples (#25974)

* Add is ispartialrp to AzureBackupDiscreteRecoveryPoint and examples

* Fix prettier issues in examples

* Including ValidateForModifyBackupRequest Defn.

* resolved comments (#26064)

* Revert IsPartialRP changes (#26070)

* Using Restricted Pattern for Vault Name (#26169)

* Handling Validation Errors (#26186)

* removing 200 status code

* LintDiff fix - using common types error response (#26187)

* whitespace handling

* Editing where clause

* Removing Where Condition

---------

Co-authored-by: Dishant Munjal <dishantmunjal@users.noreply.github.com>
Co-authored-by: chandrasekarendran <59728024+chandrasekarendran@users.noreply.github.com>
Co-authored-by: soumyapattnaik <33341338+soumyapattnaik@users.noreply.github.com>
Co-authored-by: nickpacificomsft <144935783+nickpacificomsft@users.noreply.github.com>
Co-authored-by: asmitt <62243673+asmitt@users.noreply.github.com>
zman-ms pushed a commit that referenced this pull request Jan 10, 2024
@amchandn @dishantmunjal
@chandrasekarendran @soumyapattnaik @nickpacificomsft @asmitt @zman-ms
[Hub Generated] Review request for Microsoft.DataProtection to add ve…
2997cc5 
…rsion preview/2023-08-01-preview (#25967)

* Adds base for updating Microsoft.DataProtection from version preview/2023-06-01-preview to version 2023-08-01-preview

* Updates readme

* Updates API version in new specs and examples

* Re-Validate API Swagger Changes

* JobCancel & Job InProgress changes

* vault tier changes aks (#25972)

* Add is isPartialRP boolean to AzureBackupDiscreteRecoveryPoint and examples (#25974)

* Add is ispartialrp to AzureBackupDiscreteRecoveryPoint and examples

* Fix prettier issues in examples

* Including ValidateForModifyBackupRequest Defn.

* resolved comments (#26064)

* Revert IsPartialRP changes (#26070)

* Using Restricted Pattern for Vault Name (#26169)

* Handling Validation Errors (#26186)

* removing 200 status code

* LintDiff fix - using common types error response (#26187)

* whitespace handling

* Editing where clause

* Removing Where Condition

---------

Co-authored-by: Dishant Munjal <dishantmunjal@users.noreply.github.com>
Co-authored-by: chandrasekarendran <59728024+chandrasekarendran@users.noreply.github.com>
Co-authored-by: soumyapattnaik <33341338+soumyapattnaik@users.noreply.github.com>
Co-authored-by: nickpacificomsft <144935783+nickpacificomsft@users.noreply.github.com>
Co-authored-by: asmitt <62243673+asmitt@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dishantmunjal dishantmunjal dishantmunjal left review comments

@Alancere Alancere Alancere left review comments

@rkmanda rkmanda rkmanda approved these changes

Assignees

@rkmanda rkmanda

Labels
Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager SuppressionReviewRequired
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.