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.

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 Face spec #29120

Merged
merged 3 commits into from
May 17, 2024

Update OAS

e39a80a
Select commit
Loading
Failed to load commit list.
Merged

Update Face spec #29120

Update OAS
e39a80a
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded May 17, 2024 in 5m 16s

Swagger LintDiff succeeded

Details

Compared specs (v2.2.2) new version base version
v1.1-preview.1 v1.1-preview.1(e39a80a) v1.1-preview.1(main)

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

Rule Message
⚠️ VersionConvention API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'.
Location: Face/preview/v1.1-preview.1/Face.json#L5
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L92
⚠️ 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: Face/preview/v1.1-preview.1/Face.json#L167
⚠️ 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: Face/preview/v1.1-preview.1/Face.json#L272
⚠️ 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: Face/preview/v1.1-preview.1/Face.json#L280
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L354
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L407
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L448
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Face/preview/v1.1-preview.1/Face.json#L449
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L487
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Face/preview/v1.1-preview.1/Face.json#L488
⚠️ Delete204Response A delete operation should have a 204 response.
Location: Face/preview/v1.1-preview.1/Face.json#L496
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Face/preview/v1.1-preview.1/Face.json#L497
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L524
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Face/preview/v1.1-preview.1/Face.json#L525
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L586
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L642
⚠️ Formdata Check for appropriate use of formData parameters.
Location: Face/preview/v1.1-preview.1/Face.json#L643
⚠️ Formdata Check for appropriate use of formData parameters.
Location: Face/preview/v1.1-preview.1/Face.json#L646
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L681
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Face/preview/v1.1-preview.1/Face.json#L682
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L720
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Face/preview/v1.1-preview.1/Face.json#L721
⚠️ Delete204Response A delete operation should have a 204 response.
Location: Face/preview/v1.1-preview.1/Face.json#L729
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Face/preview/v1.1-preview.1/Face.json#L730
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L757
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Face/preview/v1.1-preview.1/Face.json#L758
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L819
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L875
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L917
⚠️ PatchContentType A patch operation should consume 'application/merge-patch+json' content type.
Location: Face/preview/v1.1-preview.1/Face.json#L993
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L997
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L1079
⚠️ PageableOperation Based on the response model schema, operation 'PersonDirectoryOperations_GetDynamicPersonGroupPersons' might be pageable. Consider adding the x-ms-pageable extension.
Location: Face/preview/v1.1-preview.1/Face.json#L1124
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Face/preview/v1.1-preview.1/Face.json#L1124
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L1128
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L1189
⚠️ 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: Face/preview/v1.1-preview.1/Face.json#L1190
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L1234
⚠️ 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: Face/preview/v1.1-preview.1/Face.json#L1245
⚠️ 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: 'FaceListOperations_CreateFaceList' Request Model: 'parameters[1].schema' Response Model: 'responses[200].schema'
Location: Face/preview/v1.1-preview.1/Face.json#L1280
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L1284
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Face/preview/v1.1-preview.1/Face.json#L1358
⚠️ PatchContentType A patch operation should consume 'application/merge-patch+json' content type.
Location: Face/preview/v1.1-preview.1/Face.json#L1380
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L1383
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Face/preview/v1.1-preview.1/Face.json#L1417
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L1442
⚠️ Delete204Response A delete operation should have a 204 response.
Location: Face/preview/v1.1-preview.1/Face.json#L1454
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Face/preview/v1.1-preview.1/Face.json#L1455
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Face/preview/v1.1-preview.1/Face.json#L1483