Azure ad b2c tenant resource management APIs swagger, merge into public repo#11292
Merged
akning-ms merged 29 commits intoAzure:masterfrom Dec 14, 2020
Conversation
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L835 |
|
| 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: 'B2CTenants_Create' Request Model: 'CreateTenantRequestBody' Response Model: 'B2CTenantResource' New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L252 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L678 |
|
| 'updateTenantRequestBody' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L229 |
|
| 'createTenantRequestBody' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L276 |
|
| 'checkNameAvailabilityRequestBody' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L59 |
|
| 'reason' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L682 |
|
| 'countryCode' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L721 |
|
| 'countryCode' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L864 |
|
| 'B2CTenantResource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json#L747 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Contributor
Author
|
@ArcturusZhang, please note that ARM and Swagger reviews have already been approved by @ravbhatnagar and @lirenhe respectively. The PR on the private repo can be found here. Opened this PR to get it onto the public repo. Please advice on how to move forward with merging this PR. Added you to open email thread with a few folks involved in this. There seem to be some errors on the SDK readme's.. could use advice on how to fix those. Note that we need two sets of sdks to be generated for the two different api versions. |
|
Hi, @nickgmicrosoft 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. vsswagger@microsoft.com |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @nickgmicrosoft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ArcturusZhang |
chiragg4u
reviewed
Nov 3, 2020
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "B2CTenants", | ||
| "version": "2019-01-01-preview", |
Contributor
There was a problem hiding this comment.
"2019-01-01-preview", [](start = 15, length = 21)
Why are we adding 2 year old API version?
Contributor
Author
There was a problem hiding this comment.
Hi chiragg4u,
This is the version currently publicly exposed being used in our portal and elsewhere. With previous reviewers we discussed that it's ok to keep this version, to get it published, and consider a new version/date when this is GA'd.
chiragg4u
reviewed
Nov 3, 2020
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories": { |
Contributor
There was a problem hiding this comment.
b2cDirectories [](start = 113, length = 14)
This looks like completely new set of capabilities; please confirm if you've a formal review meeting with ARM API Review board and if yes please share the notes with armapireview@microsoft.com to take the review forward.
Contributor
Author
There was a problem hiding this comment.
Already reviewed with ARM (see other PR)
ArcturusZhang
requested changes
Nov 3, 2020
|
Swagger pipeline can not start as the pull request has merge conflicts. |
Swagger Generation Artifacts
|
ArcturusZhang
requested changes
Nov 25, 2020
Member
ArcturusZhang
left a comment
ArcturusZhang
left a comment
There was a problem hiding this comment.
Please fix the issues in readme.go.md
@changlong-liu please review the changes in readme.python.md
@allenjzhang please review the changes in readme.csharp.md
Member
|
@kairu-ms could you please have a look at the |
Contributor
Author
I reeemoved a ruby readme for now, as it's not a target sdk for public preview. |
This was referenced Dec 3, 2020
Member
|
@nickgmicrosoft I have checked the python pipeline result. Because 'azure.mgmt.azureadb2c' is new service, just need to care about 'python-track2'. The python code has been generated. It's ok for python. |
Contributor
ravbhatnagar
left a comment
ravbhatnagar
left a comment
There was a problem hiding this comment.
Signing off from ARM side
ravbhatnagar
added
ARMSignedOff
| @@ -50,15 +61,8 @@ This is not used by Autorest itself. | |||
| ```yaml $(swagger-to-sdk) | |||
| swagger-to-sdk: | |||
| - repo: azure-sdk-for-python | |||
There was a problem hiding this comment.
Suggested change
| - repo: azure-sdk-for-python |
This was referenced Dec 14, 2020
dabenhamMic
pushed a commit
to dabenhamMic/azure-rest-api-specs
that referenced
this pull request
Dec 14, 2020
…ic repo (Azure#11292) * tenant creation azure ad b2c swagger merge into public repo * adding custom word and formatting json files * fixing readmes * removing conflict with master branch * fixing readme * fixing go readme * updated service name and output folder paths * csharp reeadme for multiple versions? * csharp reeadme for multiple versions? * trimming non-public preview platform targets;cleaning up chsarp/go/python readmes * reesolving custom-words conflict * Update specification/cpim/resource-manager/readme.md Co-authored-by: Arcturus <ufo54153@gmail.com> * removing space before the yaml * restoring and appending azureresourceschema.md * Update specification/cpim/resource-manager/readme.go.md Co-authored-by: Arcturus <ufo54153@gmail.com> * Update specification/cpim/resource-manager/readme.go.md Co-authored-by: Arcturus <ufo54153@gmail.com> * api version and subscription paremeter not in method location * python readme updates * python readme updates * fixing extra commas * trying variation for go readme * Update readme.md * Update readme.python.md * Update readme.python.md * Update readme.python.md * trying to match with azure monitor readme Co-authored-by: Arcturus <ufo54153@gmail.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
giromm2ms
pushed a commit
to giromm2ms/azure-rest-api-specs
that referenced
this pull request
Dec 20, 2020
…ic repo (Azure#11292) * tenant creation azure ad b2c swagger merge into public repo * adding custom word and formatting json files * fixing readmes * removing conflict with master branch * fixing readme * fixing go readme * updated service name and output folder paths * csharp reeadme for multiple versions? * csharp reeadme for multiple versions? * trimming non-public preview platform targets;cleaning up chsarp/go/python readmes * reesolving custom-words conflict * Update specification/cpim/resource-manager/readme.md Co-authored-by: Arcturus <ufo54153@gmail.com> * removing space before the yaml * restoring and appending azureresourceschema.md * Update specification/cpim/resource-manager/readme.go.md Co-authored-by: Arcturus <ufo54153@gmail.com> * Update specification/cpim/resource-manager/readme.go.md Co-authored-by: Arcturus <ufo54153@gmail.com> * api version and subscription paremeter not in method location * python readme updates * python readme updates * fixing extra commas * trying variation for go readme * Update readme.md * Update readme.python.md * Update readme.python.md * Update readme.python.md * trying to match with azure monitor readme Co-authored-by: Arcturus <ufo54153@gmail.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
11 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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.
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 API Review Board as defined in the Breaking Change Policy.
Please follow the link to find more details on PR review process.