Skip to content
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.

Sign up for GitHub

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

[AppConfig] Migrate App Configuration swagger to TypeSpec #28634

Merged
merged 53 commits into from
May 14, 2024

add consumes

2035d70
Select commit
Loading
Failed to load commit list.
Merged

[AppConfig] Migrate App Configuration swagger to TypeSpec #28634

add consumes
2035d70
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / ~[NotRequired_Staging] Swagger LintDiff succeeded Apr 20, 2024 in 9m 2s

~[NotRequired_Staging] Swagger LintDiff succeeded

ppe/LintDiff
View Azure DevOps build log for more details.

Details

compared tags (via openapi-validator vbeta) new version base version
package-2023-11-01 package-2023-11-01(2035d70) package-2023-11-01(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2676
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2668
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2573
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2556
⚠️ PathParameterSchema Path parameter should specify characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2473
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2456
⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2286
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2278
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2265
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2209
⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2026
⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2018
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1997
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1836
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1655
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1611
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1520
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1507
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1418
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1405
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1308
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1191
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1035
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1027
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L937
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L924
⚠️ RequestBodyOptional The body parameter is not marked as required.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L868
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L826
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L805
⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L652
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L637
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L624
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L434
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L224
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L153
⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L83
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L62
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L50
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L45


The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.

Rule Message
⚠️ EnumInsteadOfBoolean 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/2023-11-01/appconfiguration.json#L2975
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2709
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2669
⚠️ PatchContentType A patch operation should only consume 'application/merge-patch+json' content type.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2565
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2557
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2457
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2266
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2235
⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2226
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2210
⚠️ PaginationResponse Response body schema of pageable response should contain top-level array property value
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L2166
⚠️ OperationId OperationId for get method on a collection should contain 'List'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1998
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1998
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1997
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1963
⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1883
⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1867
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1837
⚠️ PaginationResponse Response body schema of pageable response should contain top-level array property value
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1789
⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1707
⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1691
⚠️ OperationId OperationId for get method on a collection should contain 'List'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1656
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1656
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1655
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1612
⚠️ Delete204Response A delete operation should have a 204 response.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1559
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1508
⚠️ OperationId OperationId for put method should contain 'Create' or 'Update'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1406
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1406
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1375
⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1348
⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1332
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1309
⚠️ PaginationResponse Response body schema of pageable response should contain top-level array property value
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1265
⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1236
⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1220
⚠️ OperationId OperationId for get method on a collection should contain 'List'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1192
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1192
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1191
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1151
⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1082
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L1028
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L925
⚠️ OperationId OperationId for put method should contain 'Create' or 'Update'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L806
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L806
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L625
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L584
⚠️ ParameterNamesConvention Parameter name '$Select' should not begin with '$' or '@'.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L481
⚠️ ParameterNamesConvention Parameter name 'After' should be camel case.
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L465
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json#L435
View more details on openapi-pipeline-app