Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Configuration/RuleTransformers.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Dedoc\Scramble\Contracts\AllRulesSchemasTransformer;
use Dedoc\Scramble\Contracts\RuleTransformer;
use Dedoc\Scramble\RuleTransformers\AcceptedRule;
use Dedoc\Scramble\RuleTransformers\ConfirmedRule;
use Dedoc\Scramble\RuleTransformers\EnumRule;
use Dedoc\Scramble\RuleTransformers\ExistsRule;
Expand Down Expand Up @@ -81,6 +82,7 @@ public function instances(string $type, array $contextfulBindings): Collection
public function all(): array
{
$base = $this->transformers ?: [
AcceptedRule::class,
EnumRule::class,
InRule::class,
ConfirmedRule::class,
Expand Down
21 changes: 21 additions & 0 deletions src/RuleTransformers/AcceptedRule.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

namespace Dedoc\Scramble\RuleTransformers;

use Dedoc\Scramble\Contracts\RuleTransformer;
use Dedoc\Scramble\Support\Generator\Types\Type;
use Dedoc\Scramble\Support\RuleTransforming\NormalizedRule;
use Dedoc\Scramble\Support\RuleTransforming\RuleTransformerContext;

class AcceptedRule implements RuleTransformer
{
public function shouldHandle(NormalizedRule $rule): bool
{
return $rule->is('accepted');
}

public function toSchema(Type $previous, NormalizedRule $rule, RuleTransformerContext $context): Type
{
return $previous->enum(['yes', 'on', '1', 'true']);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Dedoc\Scramble\GeneratorConfig;
use Dedoc\Scramble\OpenApiContext;
use Dedoc\Scramble\RuleTransformers\AcceptedRule;
use Dedoc\Scramble\RuleTransformers\EnumRule;
use Dedoc\Scramble\RuleTransformers\InRule;
use Dedoc\Scramble\Support\Generator\OpenApi;
Expand Down Expand Up @@ -99,6 +100,19 @@
});
});

describe(AcceptedRule::class, function () {
test('accepted rule', function () {
$rules = ['accepted'];

$schema = $this->transformer->transform($rules);

expect($schema->toArray())->toBe([
'type' => 'string',
'enum' => ['yes', 'on', '1', 'true'],
]);
});
});

enum Enum_RuleSetToSchemaTransformerTest: string
{
case FOO = 'foo';
Expand Down
19 changes: 19 additions & 0 deletions tests/ValidationRulesDocumentingTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -951,6 +951,15 @@ public function __invoke(Request $request)

assertMatchesSnapshot($openApiDocument);
});

it('supports accepted rule', function () {
RouteFacade::get('api/test', [ValidationAcceptedRulesDocumenting_Test::class, 'index']);

Scramble::routes(fn (Route $r) => $r->uri === 'api/test');
$openApiDocument = app()->make(\Dedoc\Scramble\Generator::class)();

assertMatchesSnapshot($openApiDocument);
});
class ValidationRulesDocumenting_Test
{
/**
Expand Down Expand Up @@ -996,6 +1005,16 @@ public function index(ValidationRulesAndFormRequestAtTheSameTime_TestFormRequest
}
}

class ValidationAcceptedRulesDocumenting_Test
{
public function index(Request $request)
{
$request->validate([
'content' => ['required', 'accepted'],
]);
}
}

class ValidationRulesWithDocs_Test
{
public function index(Request $request)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
openapi: 3.1.0
info:
title: Laravel
version: 0.0.1
servers:
- { url: 'http://localhost/api' }
paths:
/test: { get: { operationId: validationAcceptedRulesDocumentingTest.index, tags: [ValidationAcceptedRulesDocumenting_Test], parameters: [{ name: content, in: query, required: true, schema: { type: string, enum: ['yes', 'on', '1', 'true'] } }], 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] } } } } }
Loading