New API version for Microsoft.Datadog RP #24495
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @vikotha Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| datadog.json | 2022-08-01(e04eb45) | 2022-06-01(main) |
| datadog.json | 2022-08-01(e04eb45) | 2020-02-01-preview(main) |
| datadog.json | 2023-01-01(e04eb45) | 2022-06-01(main) |
| datadog.json | 2023-01-01(e04eb45) | 2020-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 4 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.5) | new version | base version |
|---|---|---|
| package-2023-01 | package-2023-01(e04eb45) | default(main) |
| package-2022-08 | package-2022-08(e04eb45) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| The response of operation:'MonitoredSubscriptions_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Datadog/stable/2023-01-01/datadog.json#L1261 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Monitors_GetMonitoredSubscriptions Location: Microsoft.Datadog/stable/2023-01-01/datadog.json#L1305 |
||
| The response of operation:'MonitoredSubscriptions_CreateorUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Datadog/stable/2023-01-01/datadog.json#L1311 |
||
| The response of operation:'MonitoredSubscriptions_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Datadog/stable/2023-01-01/datadog.json#L1381 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The top-level resource 'DatadogAgreementResource' does not have list by subscription operation, please add it. Location: Microsoft.Datadog/stable/2022-08-01/datadog.json#L1166 |
|
The top-level resource 'DatadogAgreementResource' does not have list by subscription operation, please add it. Location: Microsoft.Datadog/stable/2023-01-01/datadog.json#L1538 |
| The resource DatadogAgreementResource does not have a corresponding delete operation. Location: Microsoft.Datadog/stable/2022-08-01/datadog.json#L1166 |
|
| The resource 'DatadogAgreementResource' does not have get operation, please add it. Location: Microsoft.Datadog/stable/2022-08-01/datadog.json#L1166 |
|
| The resource MonitoringTagRules does not have a corresponding delete operation. Location: Microsoft.Datadog/stable/2022-08-01/datadog.json#L1882 |
|
| The resource DatadogSingleSignOnResource does not have a corresponding delete operation. Location: Microsoft.Datadog/stable/2022-08-01/datadog.json#L1962 |
|
| The resource DatadogAgreementResource does not have a corresponding delete operation. Location: Microsoft.Datadog/stable/2023-01-01/datadog.json#L1538 |
|
| The resource 'DatadogAgreementResource' does not have get operation, please add it. Location: Microsoft.Datadog/stable/2023-01-01/datadog.json#L1538 |
|
| The resource MonitoringTagRules does not have a corresponding delete operation. Location: Microsoft.Datadog/stable/2023-01-01/datadog.json#L2395 |
|
| The resource DatadogSingleSignOnResource does not have a corresponding delete operation. Location: Microsoft.Datadog/stable/2023-01-01/datadog.json#L2475 |
️️✔️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]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
CI-FixRequiredOnFailure
CI-MissingBaseCommit
new-api-version
resource-manager
RPaaS
WaitForARMFeedback
|
Hi @vikotha, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @vikotha, 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. Or you could onboard API spec pipeline |
This was referenced Jun 19, 2023
[AutoPR @azure/arm-datadog] New API version for Microsoft.Datadog RP
azure-sdk/azure-sdk-for-js#5454
Closed
|
Hi, @vikotha your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
mukundnigam
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
sooryaveeravalli
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
mukundnigam
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
Comment on lines
24
to
55
| - tag: package-2023-01 | ||
| - tag: packag-2022-08 | ||
| - tag: package-2022-06 | ||
| - tag: package-2021-03 | ||
| - tag: package-2020-02-preview | ||
| ``` | ||
| ### Tag: package-2023-01 and go | ||
|
|
||
| These settings apply only when `--tag=package-2023-01 --go` is specified on the command line. | ||
| Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`. | ||
|
|
||
| ``` yaml $(tag) == 'package-2023-01' && $(go) | ||
| output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2023-01-01/$(namespace) | ||
| ``` | ||
|
|
||
| ### Tag: package-2022-08 and go | ||
|
|
||
| These settings apply only when `--tag=package-2022-08 --go` is specified on the command line. | ||
| Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`. | ||
|
|
||
| ``` yaml $(tag) == 'package-2022-08' && $(go) | ||
| output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2022-08-01/$(namespace) | ||
| ``` | ||
|
|
||
| ### Tag: package-2022-06 and go | ||
|
|
||
| These settings apply only when `--tag=package-2022-06 --go` is specified on the command line. | ||
| Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`. | ||
|
|
||
| ``` yaml $(tag) == 'package-2022-06' && $(go) | ||
| output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2022-06-01/$(namespace) | ||
| ``` |
There was a problem hiding this comment.
these parts serve a deprecated version of go SDK, we no longer need these. Please revert this.
There was a problem hiding this comment.
Should i remove the entire file or just revert my changes?
Comment on lines
15
to
41
| _ tag: package-2023-01 | ||
| - tag: package-2022-08 | ||
| - tag: package-2022-06-01 | ||
| - tag: package-2021-03-01 | ||
| - tag: package-2020-02-01-preview | ||
| ``` | ||
|
|
||
| ### Tag: package-2023-01 and ruby | ||
|
|
||
| These settings apply only when `--tag=package-2023-01 --ruby` is specified on the command line. | ||
| Please also specify `--ruby-sdks-folder=<path to the root directory of your azure-sdk-for-ruby clone>`. | ||
|
|
||
| ``` yaml $(tag) == 'package-2023-01' && $(ruby) | ||
| namespace: "Azure::Datadog::Mgmt::V2023_01_01" | ||
| output-folder: $(ruby-sdks-folder)/management/azure_mgmt_datadog/lib | ||
| ``` | ||
|
|
||
| ### Tag: package-2022-08 and ruby | ||
|
|
||
| These settings apply only when `--tag=package-2022-08 --ruby` is specified on the command line. | ||
| Please also specify `--ruby-sdks-folder=<path to the root directory of your azure-sdk-for-ruby clone>`. | ||
|
|
||
| ``` yaml $(tag) == 'package-2022-08' && $(ruby) | ||
| namespace: "Azure::Datadog::Mgmt::V2022_08_01" | ||
| output-folder: $(ruby-sdks-folder)/management/azure_mgmt_datadog/lib | ||
| ``` | ||
|
|
There was a problem hiding this comment.
ruby SDK also gets deprecated for quite a time, we no longer need to update this file any more, please revert it.
There was a problem hiding this comment.
Should i remove the entire file or just revert my changes?
@ArcturusZhang
|
/pr RequestMerge |
raosuhas
approved these changes
Sep 27, 2023
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This was referenced Sep 27, 2023
[ReleasePR @azure/arm-datadog] New API version for Microsoft.Datadog RP
Azure/azure-sdk-for-js#23252
Closed
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
* Fix link error for Datadog RP * Fix version * Base commit for new versions * Add new API versions for Datadog RP * Fix validations * Add sdk versions * Update datadog.json * Updating descriptions * resolving comments * adding description for cspm parameter * Fix validation * Fix lint failures * Fix examples * Add pageable * Pushing AAD renaming to Azure Entra ID changes * Revert md files * Add a new word --------- Co-authored-by: arnavshringi <88130295+arnavshringi@users.noreply.github.com> Co-authored-by: Divyansh Agarwal <83802474+divyansh3131@users.noreply.github.com> Co-authored-by: Sai Soorya Rao Veeravalli <sveeravalli@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.