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

Jump to bottom

[Key Vault] TypeSpec for Secrets library #29249

Open
wants to merge 34 commits into
base: main
Choose a base branch
from

use correct package-dir

be17543
Select commit
Loading
Failed to load commit list.
Open

[Key Vault] TypeSpec for Secrets library #29249

use correct package-dir
be17543
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff failed Nov 15, 2024 in 5m 16s

Swagger LintDiff failed

LintDiff: 24 Errors, 182 Warnings
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.3) new version base version
package-preview-7.6-preview.1 package-preview-7.6-preview.1(be17543) package-preview-7.6-preview.1(main)
package-7.5 package-7.5(be17543) package-7.5(main)

[must fix]The following errors/warnings are introduced by current PR:
Only 50 items are listed, please refer to log for more details.

Rule Message Related RPC [For API reviewers]
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L583
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L589
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L595
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L601
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L836
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L842
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L848
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L854
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L583
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L589
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L595
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L601
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L836
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L842
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L848
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L854
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L44
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L108
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L109
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L145
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L146
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L181
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L182
⚠️ PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'SetSecret' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L256
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L264
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L265
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L311
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L312
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L351
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L358
⚠️ ParameterNamesConvention Parameter name 'secret-version' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L359
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L396
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L403
⚠️ ParameterNamesConvention Parameter name 'secret-version' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L404
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L451
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L452
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L490
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L491
⚠️ 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.KeyVault/preview/7.6-preview.1/secrets.json#L579
⚠️ 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.KeyVault/preview/7.6-preview.1/secrets.json#L653
⚠️ 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.KeyVault/preview/7.6-preview.1/secrets.json#L699
⚠️ 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.KeyVault/preview/7.6-preview.1/secrets.json#L832
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L44
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L108
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L109
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L145
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L146
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L181
⚠️ ParameterNamesConvention Parameter name 'secret-name' should be camel case.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L182
⚠️ PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'SetSecret' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema'
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L256


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

Rule Message
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L662
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L668
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L708
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L714
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L662
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L668
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L708
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.KeyVault/stable/7.5/secrets.json#L714
⚠️ VersionConvention API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L5
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L56
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L57
⚠️ OperationId OperationId for get method on a collection should contain 'List'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L57
⚠️ PaginationResponse value property in pageable response should be required
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L78
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L82
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L84
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L84
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L101
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L124
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L126
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L126
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L138
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L158
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L160
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L160
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L174
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L197
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L199
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L199
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L212
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L213
⚠️ OperationId OperationId for get method on a collection should contain 'List'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L213
⚠️ PaginationResponse value property in pageable response should be required
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L234
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L238
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L240
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L240
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L257
⚠️ OperationId OperationId for put method should contain 'Create' or 'Update'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L257
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L290
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L292
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L292
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L304
⚠️ Delete204Response A delete operation should have a 204 response.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L320
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L327
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L329
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L329
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L343
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L350
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L374
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L376
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.KeyVault/preview/7.6-preview.1/secrets.json#L376
View more details on openapi-pipeline-app