-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Adding new preview version for DNC API to expose optional "purpose" parameter when creating a controller #24097
Adding new preview version for DNC API to expose optional "purpose" parameter when creating a controller #24097
Conversation
Hi, @thomasricci 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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
common-types.json | 2023-05-18-preview(3360493) | 2021-03-15(main) |
common-types.json | 2023-05-18-preview(3360493) | 2020-08-08-preview(main) |
controller.json | 2023-05-18-preview(3360493) | 2021-03-15(main) |
controller.json | 2023-05-18-preview(3360493) | 2020-08-08-preview(main) |
delegatedSubnets.json | 2023-05-18-preview(3360493) | 2021-03-15(main) |
delegatedSubnets.json | 2023-05-18-preview(3360493) | 2020-08-08-preview(main) |
operations.json | 2023-05-18-preview(3360493) | 2021-03-15(main) |
operations.json | 2023-05-18-preview(3360493) | 2020-08-08-preview(main) |
orchestrators.json | 2023-05-18-preview(3360493) | 2021-03-15(main) |
orchestrators.json | 2023-05-18-preview(3360493) | 2020-08-08-preview(main) |
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.2) | new version | base version |
---|---|---|
package-2023-05-18-preview | package-2023-05-18-preview(3360493) | default(thomasricci-dnc-Microsoft.DelegatedNetwork-2021-03-15) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L112 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L112 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L134 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L163 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L403 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/delegatedSubnets.json#L112 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/delegatedSubnets.json#L112 |
PatchResponseCode |
LRO PATCH must have 200 and 202 return codes. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/delegatedSubnets.json#L134 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/delegatedSubnets.json#L168 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/delegatedSubnets.json#L184 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/delegatedSubnets.json#L216 |
MissingTypeObject |
The schema 'ResourceUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/delegatedSubnets.json#L348 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/delegatedSubnets.json#L406 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/orchestrators.json#L112 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/orchestrators.json#L112 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/orchestrators.json#L134 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/orchestrators.json#L166 |
PatchIdentityProperty |
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/orchestrators.json#L205 |
MissingTypeObject |
The schema 'OrchestratorResourceUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/orchestrators.json#L365 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/orchestrators.json#L422 |
MissingTypeObject |
The schema 'OrchestratorIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/orchestrators.json#L466 |
The response of operation:'Controller_GetDetails' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L38 |
|
The response of operation:'Controller_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L78 |
|
The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L78 |
|
The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L134 |
|
200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L160 |
|
The response of operation:'Controller_Patch' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L178 |
|
'PATCH' operation 'Controller_Patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L188 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json#L330 |
|
The response of operation:'DelegatedSubnetService_GetDetails' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.DelegatedNetwork/preview/2023-05-18-preview/delegatedSubnets.json#L38 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @thomasricci your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
...manager/Microsoft.DelegatedNetwork/preview/2023-05-18-preview/examples/deleteController.json
Outdated
Show resolved
Hide resolved
Hi @thomasricci, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @thomasricci, 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. |
729c99d
into
Azure:thomasricci-dnc-Microsoft.DelegatedNetwork-2021-03-15
…version preview/2023-05-18 (#24148) * Adding new preview version for DNC API to expose optional "purpose" parameter when creating a controller (#24097) * creating new preview version "2013-05-18-preview" for DNC API * updating api version in files * adding purpose flag * updating readme files * moving "purpose" to custom props section * setting default for back compat * fix tests * adding location header to DELETE APIs * Removing 202 for deletes since not used in our RP * removing long running op flag from DELETE apis * rollback 202 changes for DELETE APIs and adding the LRO Location header * adding operations list test for new preview version * updating scenarios based on autorest generate-api-scenario static
…version preview/2023-05-18 (Azure#24148) * Adding new preview version for DNC API to expose optional "purpose" parameter when creating a controller (Azure#24097) * creating new preview version "2013-05-18-preview" for DNC API * updating api version in files * adding purpose flag * updating readme files * moving "purpose" to custom props section * setting default for back compat * fix tests * adding location header to DELETE APIs * Removing 202 for deletes since not used in our RP * removing long running op flag from DELETE apis * rollback 202 changes for DELETE APIs and adding the LRO Location header * adding operations list test for new preview version * updating scenarios based on autorest generate-api-scenario static
ARM API Information (Control Plane)
We are creating a new API preview version to allow customers to provision "test" controllers via AZ CLI.
This change is allowed by setting an extra (optional) parameter in the PUT request body (named
purpose
) that would let specify the type of controller you are going to create. If the parameter is not set the RP will default to "prod" for back compatibility with the existing behavior. No breaking changes to our RP API surface.Changelog
Add a changelog entry for this PR by answering the following questions:
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:
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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.