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.

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

DomainServices: Add default value for newly added "SyncScope" property #22476

Merged
merged 2 commits into from
Feb 13, 2023

Conversation

jihochang
Copy link
Contributor

@jihochang jihochang commented Feb 6, 2023

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.
  • 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.

@openapi-workflow-bot
Copy link

Hi, @jihochang Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 6, 2023

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    domainservices.json 2022-09-01(636eeab) 2022-09-01(main)
    domainservices.json 2022-12-01(636eeab) 2022-12-01(main)
    Rule Message
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.AAD/stable/2022-09-01/domainservices.json#L505:9
    Old: Microsoft.AAD/stable/2022-09-01/domainservices.json#L505:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.AAD/stable/2022-12-01/domainservices.json#L510:9
    Old: Microsoft.AAD/stable/2022-12-01/domainservices.json#L510:9
    ️️✔️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.0.0) new version base version
    package-2022-12 package-2022-12(636eeab) package-2022-12(main)
    package-2022-09 package-2022-09(636eeab) package-2022-09(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/providers/Microsoft.AAD/operations'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L30
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.AAD/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L45
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.AAD/domainServices'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L66
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L106
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L149
    ResourceNameRestriction The resource name parameter 'domainServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L149
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L150
    LongRunningResponseStatusCode A 'put' operation 'DomainServices_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L150
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L193
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L193
    DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L254
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L276
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L316
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L316
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property location.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L316
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L333
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L465
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L767
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L975
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1067
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1081
    XmsParameterLocation The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1137
    XmsParameterLocation The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1144
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/providers/Microsoft.AAD/operations'
    Location: Microsoft.AAD/stable/2022-12-01/domainservices.json#L30
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.AAD/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.AAD/stable/2022-12-01/domainservices.json#L45
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.AAD/domainServices'
    Location: Microsoft.AAD/stable/2022-12-01/domainservices.json#L66
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices'
    Location: Microsoft.AAD/stable/2022-12-01/domainservices.json#L106
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}'
    Location: Microsoft.AAD/stable/2022-12-01/domainservices.json#L149
    ResourceNameRestriction The resource name parameter 'domainServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.AAD/stable/2022-12-01/domainservices.json#L149
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.AAD/stable/2022-12-01/domainservices.json#L150
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView 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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 6, 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/domainservices/armdomainservices - Approved - 2.0.0
    +	Struct `CloudErrorBody` has been removed
    +	Struct `CloudError` has been removed

    ️❌ azure-sdk-for-net failed [Detail]
    • Code Generator Failed [Logs]Release - Generate from 288623c. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/domainservices/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • Microsoft.Azure.Management.DomainServices [View full logs]  [Release SDK Changes]
      cmderr	[msbuild] The command could not be loaded, possibly because:
      cmderr	[msbuild]   * You intended to execute a .NET application:
      cmderr	[msbuild]       The application 'msbuild' does not exist.
      cmderr	[msbuild]   * You intended to execute a .NET SDK command:
      cmderr	[msbuild]       A compatible .NET SDK was not found.
      cmderr	[msbuild] Requested SDK version: 7.0.101
      cmderr	[msbuild] global.json file: /mnt/vss/_work/1/s/azure-sdk-for-net/global.json
      cmderr	[msbuild] Installed SDKs:
      cmderr	[msbuild] Install the [7.0.101] .NET SDK or update [/mnt/vss/_work/1/s/azure-sdk-for-net/global.json] to match an installed SDK.
      cmderr	[msbuild] Learn about SDK resolution:
      cmderr	[msbuild] https://aka.ms/dotnet/sdk-not-found
      error	Script return with result [failed] code [145] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 288623c. 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/domainservices/armdomainservices [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog] - Struct `CloudErrorBody` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New type alias `ChannelBinding` with values `ChannelBindingDisabled`, `ChannelBindingEnabled`
      info	[Changelog] - New type alias `LdapSigning` with values `LdapSigningDisabled`, `LdapSigningEnabled`
      info	[Changelog] - New type alias `SyncScope` with values `SyncScopeAll`, `SyncScopeCloudOnly`
      info	[Changelog] - New field `ChannelBinding` in struct `DomainSecuritySettings`
      info	[Changelog] - New field `LdapSigning` in struct `DomainSecuritySettings`
      info	[Changelog] - New field `SyncApplicationID` in struct `DomainServiceProperties`
      info	[Changelog] - New field `SyncScope` in struct `DomainServiceProperties`
      info	[Changelog]
      info	[Changelog] Total 4 breaking change(s), 11 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 288623c. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-domainservices [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Type Alias ChannelBinding
      info	[Changelog]   - Added Type Alias LdapSigning
      info	[Changelog]   - Added Type Alias SyncScope
      info	[Changelog]   - Interface DomainSecuritySettings has a new optional parameter channelBinding
      info	[Changelog]   - Interface DomainSecuritySettings has a new optional parameter ldapSigning
      info	[Changelog]   - Interface DomainService has a new optional parameter syncApplicationId
      info	[Changelog]   - Interface DomainService has a new optional parameter syncScope
      info	[Changelog]   - Added Enum KnownChannelBinding
      info	[Changelog]   - Added Enum KnownLdapSigning
      info	[Changelog]   - Added Enum KnownSyncScope
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 288623c. 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
    • ️✔️Az.DomainServices [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 6, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/domainservices/armdomainservices https://apiview.dev/Assemblies/Review/a31d124ea2994a4ab7971f972234250a
    JavaScript @azure/arm-domainservices https://apiview.dev/Assemblies/Review/9b0dde798c3240d890286a4e85233e54

    @openapi-workflow-bot
    Copy link

    Hi @jihochang, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @jihochang
    Copy link
    Contributor Author

    jihochang commented Feb 6, 2023

    The default value for a new property "SyncScope" was not added at the time we added the new api-versions last month. We are trying to fix the incorrect swagger definition. The correction is being made to the latest two api-versions, which were rolled out together last month.

    This is causing the S360 violation for Swagger correctness as well.

    https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=2F2EC6D4-5760-465E-BAFF-3E6DD45DA30F

    @jihochang
    Copy link
    Contributor Author

    @msyyc - Please give us an update on how we can proceed with the merge. This is fixing a missing swagger spec new property default value.

    @jihochang
    Copy link
    Contributor Author

    @msyyc - We need an update on this. We will escalate to ARM team this week because our S360 violation will go red.

    @msyyc
    Copy link
    Member

    msyyc commented Feb 10, 2023

    Hi @mikekistler, Could you help review the swagger breaking change ? https://github.com/Azure/azure-rest-api-specs/pull/22476/checks?check_run_id=11144569062. Thanks!

    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 10, 2023
    @mikekistler
    Copy link
    Member

    mikekistler commented Feb 10, 2023 via email

    @jihochang
    Copy link
    Contributor Author

    Thank you Mike for approving the change.

    @msyyc - Can you help us merge the change in?

    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    Azure#22476)
    
    * Update domainservices.json
    
    * Update domainservices.json
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go FixS360 resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants