-
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
Update App Configuration management plane API description #23778
Update App Configuration management plane API description #23778
Conversation
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 | 2023-03-01(0d8420e) | 2023-03-01(main) |
️️✔️
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-2023-03-01 | package-2023-03-01(0d8420e) | package-2023-03-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/2023-03-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/2023-03-01/appconfiguration.json#L216 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json#L240 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json#L289 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.AppConfiguration/stable/2023-03-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/2023-03-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/2023-03-01/appconfiguration.json#L673 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json#L704 |
ResourceNameRestriction |
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json#L770 |
ResourceNameRestriction |
The resource name parameter 'keyValueName' should be defined with a 'pattern' restriction. Location: Microsoft.AppConfiguration/stable/2023-03-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/2023-03-01/appconfiguration.json#L923 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/stable/2023-03-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/2023-03-01/appconfiguration.json#L1057 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json#L1082 |
TrackedResourcePatchOperation |
Tracked resource 'Replica' must have patch operation that at least supports the update of tags. Location: Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json#L1205 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json#L1320 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json#L1353 |
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/2023-03-01/appconfiguration.json#L2499 |
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/2023-03-01/appconfiguration.json#L2525 |
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/2023-03-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/2023-03-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/2023-03-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/2023-03-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/2023-03-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/2023-03-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/2023-03-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/2023-03-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/2023-03-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/2023-03-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/2023-03-01/appconfiguration.json#L1057 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
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.
️️✔️
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.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
@@ -821,7 +821,7 @@ | |||
"tags": [ | |||
"KeyValues" | |||
], | |||
"description": "Gets the properties of the specified key-value.", | |||
"description": "Gets the properties of the specified key-value. NOTE: This operation is intended for use in ARM Template deployments. The data plane API should be used for other interactions with App Configuration key-values.", |
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.
Not sure if people will interpret "other interactions" as "other operations but this one". I know you mean "other scenarios but the ARM template".
Do you feel if it makes sense to include a link to our data-plane REST API doc?
https://go.microsoft.com/fwlink/?linkid=2078296
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.
Do you feel if it makes sense to include a link to our data-plane REST API doc?
I was a bit on the fence about it. Wasn't sure if it made sense to link to the dataplane REST API spec (in this repo), the link you linked, or SDK link which ultimately this is used to build.
I'm fine to add the link if you'd like.
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.
Not sure if people will interpret "other interactions" as "other operations but this one". I know you mean "other scenarios but the ARM template".
How about
NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
?
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.
NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
Love it.
I was a bit on the fence about it.
I was just throwing an idea. If a link looks like an outlier to you, I'm okay not having it.
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'll omit the link then.
Updated the wording, thanks !
@@ -821,7 +821,7 @@ | |||
"tags": [ | |||
"KeyValues" | |||
], | |||
"description": "Gets the properties of the specified key-value.", | |||
"description": "Gets the properties of the specified key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.", |
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.
Just want to get your thoughts... How do you feel about mentioning Bicep/Terraform besides of ARM template?
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.
my thought is to stick with the most fundamental piece. Kind of how SDK team refers to their JavaScript (and TypeScript) SDK as the JS SDK.
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.
Sounds good.
#sign-off |
Update App Configuration management plane API description to declare intent behind key-value management plane API.