Fix Swagger Correctness and Linting Issues for Microsoft.AAD/DomainServices #11994
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
Update to use 2020-01 as the default package
Update default values for ldapsSetting and domainSecurity
Update default values for domainSecurity and ldapsSettings
Add type and format for Version property
Add type and format for Version property
Swagger Generation Artifacts
|
|
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. |
This was referenced Dec 7, 2020
evelyn-ys
reviewed
Dec 9, 2020
There was a problem hiding this comment.
Little concern when authoring CLI
Shall migrationProperties under domainserviceProperties be marked as read-only?
definition code:
"DomainServiceProperties": {
"description": "Properties of the Domain Service.",
"properties": {
...
"migrationProperties": {
"$ref": "#/definitions/MigrationProperties",
"description": "Migration Properties"
},
...
}
},
...
"MigrationProperties": {
"description": "Migration Properties",
"properties": {
"oldSubnetId": {
"type": "string",
"description": "Old Subnet Id"
},
"oldVnetSiteId": {
"type": "string",
"description": "Old Vnet Site Id"
},
"migrationProgress": {
"$ref": "#/definitions/MigrationProgress",
"description": "Migration Progress"
}
}
},
"MigrationProgress": {
"description": "Migration Progress",
"properties": {
"completionPercentage": {
"type": "number",
"format": "double",
"description": "Completion Percentage"
},
"progressMessage": {
"type": "string",
"description": "Progress Message"
}
}
},It seems not some property which can be set or modified by any PUT operation.
Both of these are not readonly properties. |
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
Dec 9, 2020
I think migrationProperties should be marked as readonly. Let me make that change here. |
|
@jihochang |
evelyn-ys
reviewed
Dec 11, 2020
There was a problem hiding this comment.
Some other concerns:
- Shall
etagproperty underResourcebe readOnly? It seems operation time returned from server. - Do
skuproperty underDomainServicePropertieshave some allowed values? Shall we add an enum list for it? Same question fordomainConfigurationTypeunderDomainServiceProperties - Is
resourceForsetproperty underResourceForestSettingsname or type? Is there any enum values for it if it means resource forest type?
|
@weidongxu-microsoft Could we get this PR merged? Additional requests by @evelyn-ys will be in a separate PR. |
evelyn-ys
approved these changes
Dec 18, 2020
This was referenced Dec 18, 2020
giromm2ms
pushed a commit
to giromm2ms/azure-rest-api-specs
that referenced
this pull request
Dec 20, 2020
…rvices (Azure#11994) * Update readme.md Update to use 2020-01 as the default package * Update domainservices.json Update default values for ldapsSetting and domainSecurity * Update domainservices.json Update default values for domainSecurity and ldapsSettings * Update domainservices.json Add type and format for Version property * Update domainservices.json Add type and format for Version property * Mark MigrationProperties as readonly * Update MigrationProperties as readonly
josuhazure
pushed a commit
to josuhazure/azure-rest-api-specs
that referenced
this pull request
Jan 6, 2021
…rvices (Azure#11994) * Update readme.md Update to use 2020-01 as the default package * Update domainservices.json Update default values for ldapsSetting and domainSecurity * Update domainservices.json Update default values for domainSecurity and ldapsSettings * Update domainservices.json Add type and format for Version property * Update domainservices.json Add type and format for Version property * Mark MigrationProperties as readonly * Update MigrationProperties as readonly
|
@evelyn-ys it doesn't seem that there was ever a follow up PR to fix the |
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.
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.
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.
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.