adding activeDirectoryConnectors resource type (2022-03-01-preview) #17825
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, @sasank-chaganty 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. [email protected] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The child tracked resource, 'activeDirectoryConnectors' with immediate parent 'DataControllerResource', must have a list by immediate parent operation. Location: Microsoft.AzureArcData/preview/2022-03-01-preview/activeDirectoryConnectors.json#L29 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: preferK8sDnsForPtrLookups Location: Microsoft.AzureArcData/preview/2022-03-01-preview/activeDirectoryConnectors.json#L137 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: dev Location: Microsoft.AzureArcData/preview/2022-03-01-preview/common.json#L18 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/preview/2022-03-01-preview/azurearcdata.json#L693 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/preview/2022-03-01-preview/azurearcdata.json#L752 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/preview/2022-03-01-preview/azurearcdata.json#L796 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/preview/2022-03-01-preview/azurearcdata.json#L836 |
|
| 'PUT' operation 'DataControllers_PutDataController' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/preview/2022-03-01-preview/azurearcdata.json#L693 |
|
| 'PATCH' operation 'DataControllers_PatchDataController' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/preview/2022-03-01-preview/azurearcdata.json#L836 |
|
| Guid used in model definition 'OnPremiseProperty' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AzureArcData/preview/2022-03-01-preview/dataControllers.json#L158 |
|
| Guid used in model definition 'LogAnalyticsWorkspaceConfig' for property 'workspaceId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AzureArcData/preview/2022-03-01-preview/dataControllers.json#L181 |
|
| Guid used in model definition 'UploadServicePrincipal' for property 'clientId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AzureArcData/preview/2022-03-01-preview/dataControllers.json#L201 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.AzureArcData/preview/2022-03-01-preview/operations.json#L35 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: dev Location: Microsoft.AzureArcData/preview/2022-03-01-preview/sqlManagedInstances.json#L65 |
|
| The tracked resource, 'DataControllerResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.AzureArcData/preview/2022-03-01-preview/dataControllers.json#L10 |
|
| The tracked resource, 'DataControllerResource', must have a list by subscriptions operation. Location: Microsoft.AzureArcData/preview/2022-03-01-preview/dataControllers.json#L10 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Updates a SQL Server Instance tags. Location: Microsoft.AzureArcData/preview/2022-03-01-preview/azurearcdata.json#L503 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Updates a SQL Server Instance tags. Location: Microsoft.AzureArcData/preview/2022-03-01-preview/azurearcdata.json#L600 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'Operations' could not be found in the namespace 'Microsoft.AzureArcData' for api version '2022-03-01-preview'. The supported api-versions are '2020-12-08-preview, 2021-07-01-preview, 2021-08-01, 2021-11-01'." |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 2 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2022-03-01-preview/azurearcdata.json compared with base:stable/2021-11-01/azurearcdata.json
- current:preview/2022-03-01-preview/azurearcdata.json compared with base:preview/2021-07-01-preview/azurearcdata.json
- current:preview/2022-03-01-preview/common.json compared with base:stable/2021-11-01/common.json
- current:preview/2022-03-01-preview/dataControllers.json compared with base:stable/2021-11-01/dataControllers.json
- current:preview/2022-03-01-preview/operations.json compared with base:stable/2021-11-01/operations.json
- current:preview/2022-03-01-preview/sqlManagedInstances.json compared with base:stable/2021-11-01/sqlManagedInstances.json
- current:preview/2022-03-01-preview/sqlServerInstances.json compared with base:stable/2021-11-01/sqlServerInstances.json
| Rule | Message |
|---|---|
| The new version is missing a definition that was found in the old version. Was 'SystemData' removed or renamed? New: azure-rest-api-specs/blob/6a28518e4be7fbcd48d75f839d6530de79fa1c14/revision:3950:2 Old: Microsoft.AzureArcData/preview/2021-07-01-preview/azurearcdata.json#L1235:3 |
|
| The new version is missing a definition that was found in the old version. Was 'IdentityType' removed or renamed? New: azure-rest-api-specs/blob/6a28518e4be7fbcd48d75f839d6530de79fa1c14/revision:3950:2 Old: Microsoft.AzureArcData/preview/2021-07-01-preview/azurearcdata.json#L1235:3 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
|
Hi @sasank-chaganty, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 11, 2022
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-BreakingChange-Go-V2
labels
sasank-chaganty
force-pushed
the
sachaga-dev-azurearcdata-Microsoft.AzureArcData-2022-03-01-preview
branch
from
1a92350 to
6a28518
Compare
openapi-pipeline-app
bot
added
CI-BreakingChange-Go-V2
and removed
CI-FixRequiredOnFailure
labels
@changlong-liu We are not removing any field from the swagger for SQL as well as common types for this API version. The real diff is in this link. I did swagger refactor before on 2021-11-01 and 2021-08-01 version and not quite sure if these are causing issues. Another thing is that we are very sure that no our customer is using GO SDK. So there wouldn't be any impact to the customer. This swagger change is essentially blocking the next release for SqlServerInstance which includes ExtendedSupportUnit for SQL Server 2012 and other version, and it has a pretty tight deadline. We would appreciate if you can approve and merge the PR or would allow us to address the issue in a separate PR. Thanks. |
changlong-liu
added
the
Approved-OkToMerge
|
Hi @sasank-chaganty , @sureleo , The new api version has not been deployed online in ARM, hasn't it? (since the "API Readiness Check" failed) I added 'Approved-OkToMerge' label for the review is done, but don't merge this PR since the swagger should only be merged after the service is ready. Since the '' |
Thanks @changlong-liu. Actually our RP is an RPaas RP. The first thing to release a new API version in RPaas RP is to check in the Swagger. After that, we just need to do a manifest rollout. In other words, without Swagger being merged, we cannot deploy it in ARM. Let me know if this makes sense to you. |
Hi @sureleo, as I know swagger pr's approval is enough for release new api-version :) |
@changlong-liu Are you sure this is also the case with RPaas RP? We have been checking in the Swagger first for all of our API version bumps. With RPaas RP, we don’t need to write any code but just specify the checked in Swagger URL and RPaas will take the rest once manifest rollout. |
Thanks for the clarification, merging PR |
changlong-liu
approved these changes
Mar 2, 2022
This was referenced Mar 2, 2022
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
Mar 7, 2022
…zure#17825) * Adds base for updating Microsoft.AzureArcData from version stable/2021-11-01 to version 2022-03-01-preview * Updates readme * Updates API version in new specs and examples * adding activeDirectoryConnectors resource type * setting integer format * added example files * ran prettier check * fixing model errors * removing tags * removing patch * adding array identifier * add array identifier * prettier fix * fixing linter errors and warnings * fixing linting errors * fixing more lint warnings * reverted changes to DC method names * updating operations list * merging ESU updates to swagger * changed description for keytab file * adding terms to custom words * simplifying AD domain controller model * adding postgres instances * removing duplicated property BasicLogin * fixing syntax error * fixing linting warnings
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.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.