-
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
[Hub Generated] Publish private branch 'user/jimmyca/fixAppConfigSpec' #19882
[Hub Generated] Publish private branch 'user/jimmyca/fixAppConfigSpec' #19882
Conversation
* Remove list key values operation. * Update description for PUT private endpoint connection to be clear it can't be used to create. * Added example for list operations API.
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/7780 |
Hi, @jimmyca15 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.4)] | new version | base version |
---|---|---|
appconfiguration.json | 2022-05-01(7abd680) | 2022-05-01(main) |
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues' removed or restructured? Old: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L815:5 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
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-05-01 | package-2022-05-01(7abd680) | package-2022-05-01(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L154 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L216 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L240 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L289 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L562 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L610 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L673 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L704 |
ResourceNameRestriction |
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L770 |
ResourceNameRestriction |
The resource name parameter 'keyValueName' should be defined with a 'pattern' restriction. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L819 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L923 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L954 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1057 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1082 |
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.AppConfiguration/stable/2022-05-01/appconfiguration.json#L2186 |
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.AppConfiguration/stable/2022-05-01/appconfiguration.json#L2212 |
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.AppConfiguration/stable/2022-05-01/appconfiguration.json#L154 |
|
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.AppConfiguration/stable/2022-05-01/appconfiguration.json#L216 |
|
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.AppConfiguration/stable/2022-05-01/appconfiguration.json#L260 |
|
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L563 |
|
The response of operation:'PrivateEndpointConnections_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L610 |
|
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.AppConfiguration/stable/2022-05-01/appconfiguration.json#L610 |
|
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.AppConfiguration/stable/2022-05-01/appconfiguration.json#L673 |
|
The response of operation:'KeyValues_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L820 |
|
The response of operation:'KeyValues_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L867 |
|
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.AppConfiguration/stable/2022-05-01/appconfiguration.json#L923 |
|
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.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1057 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ConfigurationStores_CheckNameAvailable Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1143 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ConfigurationStores_CheckNameNotAvailable Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1143 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1260 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
Operation coverage: total: 0, untested: 0, failed: 0, passed: 0
Traffic Validation is finished. Check pipeline artifact for detail report.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
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
|
Hi @jimmyca15, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @jimmyca15, 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. |
All breaking changes have been approved in the private repo PR. |
Hello @qiaozha please let me know if there is anything I need to do to complete this PR. All approvals, including breaking change approval can be found in the private branch PR that this was published from. |
Hello @qiaozha The breaking changes for this were approved in the private repo. can we merge this? |
@jimmyca15 Can you fix the avocado failure and prettier check failure ? |
The api breaking change is approved in previous private repo PR. |
...guration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I saw there are the reasons in the corresponding private PR. Approved
@jimmyca15 can you fix the swagger model validation errors ? |
Also, there's staging lint diff error |
@qiaozha Wouldn't fixing those model validation errors be an unapproved breaking change? Also, the lint diff error is the approved breaking change this PR is making. Is there a way for me to silence that lint diff error? |
@raych1 Can you help take a look at the Model Validation error ? Thanks |
- suppress: R4015 | ||
from: appconfiguration.json | ||
where: $.definitions.KeyValue | ||
- suppress: R3010 | ||
from: appconfiguration.json | ||
where: $.definitions.KeyValue |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jianyexi Can you help review the suppression directive here ? Thanks
@ArcturusZhang Can you help take a look at the dotnet sdk track2 generation error ? Thanks |
@qiaozha I see you mentioned some people. Should I be reaching out to these individuals for the concerns you mentioned? We really need this checked in. Please note that all these breaking changes were requested and approved in the private repo PR this was generated from. https://github.com/Azure/azure-rest-api-specs-pr/pull/7780 |
@jimmyca15 , please refer to this example to add LRO headers to swagger examples to fix |
635a22f
to
6d6032b
Compare
6d6032b
to
7abd680
Compare
@raych1 I have added it and resolved the model validation errors. |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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:
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.
-[ ] 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.
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.