void type correctly transformed to response

dedoc · Jun 20, 2024 · 160541b · 160541b
1 parent 4987b24
commit 160541b
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 9 deletions.
diff --git a/src/ScrambleServiceProvider.php b/src/ScrambleServiceProvider.php
@@ -44,6 +44,7 @@
 use Dedoc\Scramble\Support\TypeToSchemaExtensions\LengthAwarePaginatorTypeToSchema;
 use Dedoc\Scramble\Support\TypeToSchemaExtensions\ModelToSchema;
 use Dedoc\Scramble\Support\TypeToSchemaExtensions\ResponseTypeToSchema;
+use Dedoc\Scramble\Support\TypeToSchemaExtensions\VoidTypeToSchema;
 use PhpParser\ParserFactory;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
@@ -160,6 +161,7 @@ public function configurePackage(Package $package): void
                     AnonymousResourceCollectionTypeToSchema::class,
                     LengthAwarePaginatorTypeToSchema::class,
                     ResponseTypeToSchema::class,
+                    VoidTypeToSchema::class,
                 ]),
                 array_merge($exceptionToResponseExtensions, [
                     ValidationExceptionToResponseExtension::class,

diff --git a/src/Support/TypeToSchemaExtensions/VoidTypeToSchema.php b/src/Support/TypeToSchemaExtensions/VoidTypeToSchema.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Dedoc\Scramble\Support\TypeToSchemaExtensions;
+
+use Dedoc\Scramble\Extensions\TypeToSchemaExtension;
+use Dedoc\Scramble\Support\Generator\Response;
+use Dedoc\Scramble\Support\Type\Generic;
+use Dedoc\Scramble\Support\Type\Type;
+use Dedoc\Scramble\Support\Type\VoidType;
+
+class VoidTypeToSchema extends TypeToSchemaExtension
+{
+    public function shouldHandle(Type $type)
+    {
+        return $type instanceof VoidType;
+    }
+
+    /**
+     * @param  Generic  $type
+     */
+    public function toResponse(Type $type)
+    {
+        return Response::make(200);
+    }
+}
diff --git a/tests/__snapshots__/ErrorsResponsesTest__it_adds_authorization_error_response__1.yml b/tests/__snapshots__/ErrorsResponsesTest__it_adds_authorization_error_response__1.yml
@@ -5,6 +5,6 @@ info:
 servers:
     - { url: 'http://localhost/api' }
 paths:
-    /test: { get: { operationId: errorsResponsesTest.addsAuthorizationErrorResponse, tags: [ErrorsResponsesTest_], responses: { 200: { description: '', content: { application/json: { schema: { type: string } } } }, 403: { $ref: '#/components/responses/AuthorizationException' } } } }
+    /test: { get: { operationId: errorsResponsesTest.addsAuthorizationErrorResponse, tags: [ErrorsResponsesTest_], responses: { 200: { description: '' }, 403: { $ref: '#/components/responses/AuthorizationException' } } } }
 components:
     responses: { AuthorizationException: { description: 'Authorization error', content: { application/json: { schema: { type: object, properties: { message: { type: string, description: 'Error overview.' } }, required: [message] } } } } }
diff --git a/...s/__snapshots__/ErrorsResponsesTest__it_adds_errors_responses_with_custom_requests__1.yml b/...s/__snapshots__/ErrorsResponsesTest__it_adds_errors_responses_with_custom_requests__1.yml
@@ -5,6 +5,6 @@ info:
 servers:
     - { url: 'http://localhost/api' }
 paths:
-    /test: { get: { operationId: errorsResponsesTest.addsErrorsWithCustomRequest, tags: [ErrorsResponsesTest_], parameters: [{ name: foo, in: query, required: true, schema: { type: string } }], responses: { 200: { description: '', content: { application/json: { schema: { type: string } } } }, 422: { $ref: '#/components/responses/ValidationException' }, 403: { $ref: '#/components/responses/AuthorizationException' } } } }
+    /test: { get: { operationId: errorsResponsesTest.addsErrorsWithCustomRequest, tags: [ErrorsResponsesTest_], parameters: [{ name: foo, in: query, required: true, schema: { type: string } }], responses: { 200: { description: '' }, 422: { $ref: '#/components/responses/ValidationException' }, 403: { $ref: '#/components/responses/AuthorizationException' } } } }
 components:
     responses: { ValidationException: { description: 'Validation error', content: { application/json: { schema: { type: object, properties: { message: { type: string, description: 'Errors overview.' }, errors: { type: object, description: 'A detailed description of each field that failed validation.', additionalProperties: { type: array, items: { type: string } } } }, required: [message, errors] } } } }, AuthorizationException: { description: 'Authorization error', content: { application/json: { schema: { type: object, properties: { message: { type: string, description: 'Error overview.' } }, required: [message] } } } } }
diff --git a/tests/__snapshots__/ErrorsResponsesTest__it_adds_not_found_error_response__1.yml b/tests/__snapshots__/ErrorsResponsesTest__it_adds_not_found_error_response__1.yml
@@ -5,6 +5,6 @@ info:
 servers:
     - { url: 'http://localhost/api' }
 paths:
-    '/test/{user}': { get: { operationId: errorsResponsesTest.addsNotFoundErrorResponse, tags: [ErrorsResponsesTest_], parameters: [{ name: user, in: path, required: true, description: 'The user ID', schema: { type: integer } }], responses: { 200: { description: '', content: { application/json: { schema: { type: string } } } }, 404: { $ref: '#/components/responses/ModelNotFoundException' }, 403: { $ref: '#/components/responses/AuthorizationException' } } } }
+    '/test/{user}': { get: { operationId: errorsResponsesTest.addsNotFoundErrorResponse, tags: [ErrorsResponsesTest_], parameters: [{ name: user, in: path, required: true, description: 'The user ID', schema: { type: integer } }], responses: { 200: { description: '' }, 404: { $ref: '#/components/responses/ModelNotFoundException' }, 403: { $ref: '#/components/responses/AuthorizationException' } } } }
 components:
     responses: { ModelNotFoundException: { description: 'Not found', content: { application/json: { schema: { type: object, properties: { message: { type: string, description: 'Error overview.' } }, required: [message] } } } }, AuthorizationException: { description: 'Authorization error', content: { application/json: { schema: { type: object, properties: { message: { type: string, description: 'Error overview.' } }, required: [message] } } } } }
diff --git a/tests/__snapshots__/ErrorsResponsesTest__it_adds_validation_error_response__1.yml b/tests/__snapshots__/ErrorsResponsesTest__it_adds_validation_error_response__1.yml
@@ -5,6 +5,6 @@ info:
 servers:
     - { url: 'http://localhost/api' }
 paths:
-    /test: { get: { operationId: errorsResponsesTest.addsValidationErrorResponse, tags: [ErrorsResponsesTest_], parameters: [{ name: foo, in: query, required: true, schema: { type: string } }], responses: { 200: { description: '', content: { application/json: { schema: { type: string } } } }, 422: { $ref: '#/components/responses/ValidationException' } } } }
+    /test: { get: { operationId: errorsResponsesTest.addsValidationErrorResponse, tags: [ErrorsResponsesTest_], parameters: [{ name: foo, in: query, required: true, schema: { type: string } }], responses: { 200: { description: '' }, 422: { $ref: '#/components/responses/ValidationException' } } } }
 components:
     responses: { ValidationException: { description: 'Validation error', content: { application/json: { schema: { type: object, properties: { message: { type: string, description: 'Errors overview.' }, errors: { type: object, description: 'A detailed description of each field that failed validation.', additionalProperties: { type: array, items: { type: string } } } }, required: [message, errors] } } } } }
diff --git a/..._/ErrorsResponsesTest__it_adds_validation_error_response_when_documented_in_phpdoc__1.yml b/..._/ErrorsResponsesTest__it_adds_validation_error_response_when_documented_in_phpdoc__1.yml
@@ -5,6 +5,6 @@ info:
 servers:
     - { url: 'http://localhost/api' }
 paths:
-    /test: { get: { operationId: errorsResponsesTest.phpdocExceptionResponse, tags: [ErrorsResponsesTest_], responses: { 200: { description: '', content: { application/json: { schema: { type: string } } } }, 422: { $ref: '#/components/responses/ValidationException' } } } }
+    /test: { get: { operationId: errorsResponsesTest.phpdocExceptionResponse, tags: [ErrorsResponsesTest_], responses: { 200: { description: '' }, 422: { $ref: '#/components/responses/ValidationException' } } } }
 components:
     responses: { ValidationException: { description: 'Validation error', content: { application/json: { schema: { type: object, properties: { message: { type: string, description: 'Errors overview.' }, errors: { type: object, description: 'A detailed description of each field that failed validation.', additionalProperties: { type: array, items: { type: string } } } }, required: [message, errors] } } } } }
diff --git a/...ErrorsResponsesTest__it_adds_validation_error_response_with_facade_made_validators__1.yml b/...ErrorsResponsesTest__it_adds_validation_error_response_with_facade_made_validators__1.yml
@@ -5,6 +5,6 @@ info:
 servers:
     - { url: 'http://localhost/api' }
 paths:
-    /test: { get: { operationId: errorsResponsesTest.addsValidationErrorResponseWithFacadeMadeValidators, tags: [ErrorsResponsesTest_], parameters: [{ name: foo, in: query, required: true, schema: { type: string } }], responses: { 200: { description: '', content: { application/json: { schema: { type: string } } } }, 422: { $ref: '#/components/responses/ValidationException' } } } }
+    /test: { get: { operationId: errorsResponsesTest.addsValidationErrorResponseWithFacadeMadeValidators, tags: [ErrorsResponsesTest_], parameters: [{ name: foo, in: query, required: true, schema: { type: string } }], responses: { 200: { description: '' }, 422: { $ref: '#/components/responses/ValidationException' } } } }
 components:
     responses: { ValidationException: { description: 'Validation error', content: { application/json: { schema: { type: object, properties: { message: { type: string, description: 'Errors overview.' }, errors: { type: object, description: 'A detailed description of each field that failed validation.', additionalProperties: { type: array, items: { type: string } } } }, required: [message, errors] } } } } }
diff --git a/...ValidationRulesDocumentingTest__it_extracts_rules_from_Validator__make_facade_call__1.yml b/...ValidationRulesDocumentingTest__it_extracts_rules_from_Validator__make_facade_call__1.yml
@@ -5,4 +5,4 @@ info:
 servers:
     - { url: 'http://localhost/api' }
 paths:
-    /test: { get: { operationId: validationFacadeRulesDocumentingTest.index, tags: [ValidationFacadeRulesDocumenting_Test], parameters: [{ name: content, in: query, required: true, schema: { type: string, enum: [wow] } }], responses: { 200: { description: '', content: { application/json: { schema: { type: string } } } } } } }
+    /test: { get: { operationId: validationFacadeRulesDocumentingTest.index, tags: [ValidationFacadeRulesDocumenting_Test], parameters: [{ name: content, in: query, required: true, schema: { type: string, enum: [wow] } }], responses: { 200: { description: '' } } } }
diff --git a/...snapshots__/ValidationRulesDocumentingTest__it_supports_manual_authentication_info__1.yml b/...snapshots__/ValidationRulesDocumentingTest__it_supports_manual_authentication_info__1.yml
@@ -7,6 +7,6 @@ servers:
 security:
     - { apiKey: {  } }
 paths:
-    /test: { get: { operationId: controllerWithoutSecurity.index, tags: [WithoutSecurity], responses: { 200: { description: '', content: { application/json: { schema: { type: string } } } } }, security: [{  }] } }
+    /test: { get: { operationId: controllerWithoutSecurity.index, tags: [WithoutSecurity], responses: { 200: { description: '' } }, security: [{  }] } }
 components:
     securitySchemes: { apiKey: { type: apiKey, in: query, name: api_token } }
diff --git a/...lesDocumentingTest__it_supports_validation_rules_and_form_request_at_the_same_time__1.yml b/...lesDocumentingTest__it_supports_validation_rules_and_form_request_at_the_same_time__1.yml
@@ -5,6 +5,6 @@ info:
 servers:
     - { url: 'http://localhost/api' }
 paths:
-    /test: { get: { operationId: validationRulesAndFormRequestAtTheSameTimeTest.index, tags: [ValidationRulesAndFormRequestAtTheSameTime_Test], parameters: [{ name: from_form_request, in: query, schema: { type: integer } }, { name: from_validate_call, in: query, required: true, schema: { type: string } }], responses: { 200: { description: '', content: { application/json: { schema: { type: string } } } }, 422: { $ref: '#/components/responses/ValidationException' } } } }
+    /test: { get: { operationId: validationRulesAndFormRequestAtTheSameTimeTest.index, tags: [ValidationRulesAndFormRequestAtTheSameTime_Test], parameters: [{ name: from_form_request, in: query, schema: { type: integer } }, { name: from_validate_call, in: query, required: true, schema: { type: string } }], responses: { 200: { description: '' }, 422: { $ref: '#/components/responses/ValidationException' } } } }
 components:
     responses: { ValidationException: { description: 'Validation error', content: { application/json: { schema: { type: object, properties: { message: { type: string, description: 'Errors overview.' }, errors: { type: object, description: 'A detailed description of each field that failed validation.', additionalProperties: { type: array, items: { type: string } } } }, required: [message, errors] } } } } }