-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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 Services: add 09-01-2022 API version #20768
Conversation
Hi, @ehunter1878 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] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.2)] | new version | base version |
---|---|---|
domainservices.json | 2022-09-01(709e414) | 2021-05-01(main) |
oucontainer.json | 2022-09-01(709e414) | 2021-05-01(main) |
️️✔️
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-09 | package-2022-09(709e414) | default(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#L766 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L974 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1066 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1080 |
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#L1136 |
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#L1143 |
PathResourceProviderMatchNamespace |
The last resource provider 'Microsoft.Aad' doesn't match the namespace. Location: Microsoft.AAD/stable/2022-09-01/oucontainer.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/oucontainer.json#L51 |
PathResourceProviderMatchNamespace |
The last resource provider 'Microsoft.Aad' doesn't match the namespace. Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L66 |
ResourceNameRestriction |
The resource name parameter 'domainServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L66 |
PathResourceProviderMatchNamespace |
The last resource provider 'Microsoft.Aad' doesn't match the namespace. Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L112 |
ResourceNameRestriction |
The resource name parameter 'domainServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L112 |
ResourceNameRestriction |
The resource name parameter 'ouContainerName' should be defined with a 'pattern' restriction. Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L112 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
Tag package-2022-09; Prod region: Not deployed; Canary region: Not deployed
️️✔️
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.
Swagger Generation Artifacts
|
Generated ApiView
|
Thank you for your contribution ehunter1878! We will review the pull request and get back to you soon. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Hi @ehunter1878, Your PR has some issues. Please fix the CI sequentially by following the order of
|
...fication/domainservices/resource-manager/Microsoft.AAD/stable/2022-09-01/domainservices.json
Outdated
Show resolved
Hide resolved
...fication/domainservices/resource-manager/Microsoft.AAD/stable/2022-09-01/domainservices.json
Show resolved
Hide resolved
...fication/domainservices/resource-manager/Microsoft.AAD/stable/2022-09-01/domainservices.json
Show resolved
Hide resolved
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Hi @ehunter1878, 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. |
@ehunter1878 Can you try again? I closed and reopened this PR, following the comments in microsoft/ContributorLicenseAgreement#54 |
@microsoft-github-policy-service agree company="Microsoft" |
@raych1 please help check the ModelValidation errors |
e4c2f99
to
ac61f40
Compare
@raych1 could you help with the ModelValidation errors? I attempted a fix but that caused more problems. |
@mentat9 is there anything else we need to do to get this reviewed and checked in? |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
* Add new API folder * Add new API 2022-09-01 * Fixed casing and naming issues * Fixing Swagger Violations * Fix date-time invalid format * Fix DateTime attempt 2 * Fix DateTime attempt 3 * Fix Prettier Check * Fixing Swagger Violations for LRO
* Add new API folder * Add new API 2022-09-01 * Fixed casing and naming issues * Fixing Swagger Violations * Fix date-time invalid format * Fix DateTime attempt 2 * Fix DateTime attempt 3 * Fix Prettier Check * Fixing Swagger Violations for LRO
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:
October 2022
October 2022
Contribution checklist (MS Employees Only):
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:
[ X ] 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.
-[ X ] 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.
[ X ] 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.