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

AAD Domain Service 2021-05-01 API version #14415

Merged
merged 5 commits into from
May 21, 2021
Merged

Conversation

caalmont
Copy link
Contributor

@caalmont caalmont commented May 14, 2021

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

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

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

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 14, 2021

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 0 Warnings warning [Detail]
The following errors/warnings exist before current PR submission:

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

Rule Message
R3020 - PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/providers/Microsoft.AAD/operations'
Location: Microsoft.AAD/stable/2021-05-01/domainservices.json#L30
R3020 - PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.AAD/domainServices'
Location: Microsoft.AAD/stable/2021-05-01/domainservices.json#L66
R3020 - PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices'
Location: Microsoft.AAD/stable/2021-05-01/domainservices.json#L106
R3020 - PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}'
Location: Microsoft.AAD/stable/2021-05-01/domainservices.json#L149
R4011 - DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
Location: Microsoft.AAD/stable/2021-05-01/domainservices.json#L275
R4018 - 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/2021-05-01/domainservices.json#L30
⚠️ R2017 - PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'OuContainer_Create' Request Model: 'ContainerAccount' Response Model: 'OuContainer'
Location: Microsoft.AAD/stable/2021-05-01/oucontainer.json#L157
⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'OuContainerModel'. Consider using the plural form of 'OuContainer' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.AAD/stable/2021-05-01/oucontainer.json#L71
⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'OuContainerModel'. Consider using the plural form of 'OuContainer' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.AAD/stable/2021-05-01/oucontainer.json#L117
⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'OuContainerModel'. Consider using the plural form of 'OuContainer' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.AAD/stable/2021-05-01/oucontainer.json#L161
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"domainservices/resource-manager/readme.md",
"tag":"package-2021-05",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"domainservices/resource-manager/readme.md",
"tag":"package-2021-05",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"domainservices/resource-manager/readme.md",
"tag":"package-2021-05",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @caalmont 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 14, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from fee55e3. 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
      Resource not accessible by integration
      HttpError: Resource not accessible by integration
          at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@octokit/request@5.4.15/node_modules/@octokit/request/dist-node/index.js:68:23
          at processTicksAndRejections (internal/process/task_queues.js:95:5)
          at async workflowPkgUpdatePR (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:330:21)
          at async Object.exports.workflowPkgMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:41:5)
          at async workflowHandleReadmeMd (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:172:9)
          at async Object.exports.workflowMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
          at async Object.exports.sdkAutoMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
          at async /home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    • ️✔️Az.DomainServices [View full logs
      error	Fatal error: Resource not accessible by integration
      error	The following packages are still pending:
      error		Az.DomainServices
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fee55e3. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/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]
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fee55e3. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️domainservices/mgmt/2021-05-01/aad [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️domainservices/mgmt/2020-01-01/aad [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New struct `MigrationProgress`
      info	[Changelog] - New struct `MigrationProperties`
      info	[Changelog] - New field `MigrationProperties` in struct `DomainServiceProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 5 additive change(s).
      info	[Changelog]
    • ️✔️domainservices/mgmt/2017-06-01/aad [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New struct `MigrationProgress`
      info	[Changelog] - New struct `MigrationProperties`
      info	[Changelog] - New field `MigrationProperties` in struct `DomainServiceProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 5 additive change(s).
      info	[Changelog]
    • ️✔️domainservices/mgmt/2017-01-01/aad [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fee55e3. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/domainservices/resource-manager/readme.md
    • ️✔️@azure/arm-domainservices [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/domainservicesManagementClient.js → ./dist/arm-domainservices.js...
      cmderr	[npmPack] created ./dist/arm-domainservices.js in 323ms
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    [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.

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label May 14, 2021
    @ghost
    Copy link

    ghost commented May 14, 2021

    Thank you for your contribution caalmont! We will review the pull request and get back to you soon.

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 14, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @caalmont your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @qianwens

    Copy link
    Contributor

    @pilor pilor left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Approving with 1 minor comment

    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 14, 2021
    @jihochang
    Copy link
    Contributor

    @qianwens could you please take a look and merge this PR? This change is urgent to get our new api-version out to customers.

    @caalmont
    Copy link
    Contributor Author

    @qianwens / @ArcturusZhang please let's resolve this PR ASAP, thank you.

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Approve for the changes in readme.go.md

    @caalmont
    Copy link
    Contributor Author

    @qianwens / @ArcturusZhang / @pilor it seems i don't have permission to complete and merge PR, can anyone please do so? or further steps i need to compelte?

    @ArcturusZhang
    Copy link
    Member

    @qianwens / @ArcturusZhang / @pilor it seems i don't have permission to complete and merge PR, can anyone please do so? or further steps i need to compelte?

    Please proceed with the assignee @qianwens

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review customer-reported Issues that are reported by GitHub users external to the Azure organization.
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants