Skip to content

Commit

Permalink
styles: fix styling
Browse files Browse the repository at this point in the history
  • Loading branch information
Pjotr van der Horst committed May 14, 2024
1 parent 5ab90cf commit 1e4ba71
Show file tree
Hide file tree
Showing 34 changed files with 376 additions and 376 deletions.
2 changes: 1 addition & 1 deletion src/Builders/InfoBuilder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
class InfoBuilder extends Builder
{
/**
* @return \GoldSpecDigital\ObjectOrientedOAS\Objects\Info
* @return Info
*/
public function build(): Info
{
Expand Down
10 changes: 5 additions & 5 deletions src/Builders/Paths/Operation/ParameterBuilder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
class ParameterBuilder extends Builder
{
/**
* @param \LaravelJsonApi\OpenApiSpec\Route $route
* @param Route $route
*
* @return \GoldSpecDigital\ObjectOrientedOAS\Objects\Parameter[]
*/
Expand All @@ -27,10 +27,10 @@ public function build(Route $route): array
*/
if ($route->action() === 'index') {
$parameters = [
...$parameters,
...$schemaDescriptor->pagination($route),
...$schemaDescriptor->sortables($route),
...$schemaDescriptor->filters($route),
...$parameters,
...$schemaDescriptor->pagination($route),
...$schemaDescriptor->sortables($route),
...$schemaDescriptor->filters($route),
];
}

Expand Down
18 changes: 9 additions & 9 deletions src/Builders/Paths/Operation/RequestBodyBuilder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ class RequestBodyBuilder extends Builder
protected SchemaBuilder $schemaBuilder;

protected array $descriptors = [
Controllers\Actions\Store::class => Descriptors\Requests\Store::class,
Controllers\Actions\Update::class => Descriptors\Requests\Update::class,
Controllers\Actions\AttachRelationship::class => Descriptors\Requests\AttachRelationship::class,
Controllers\Actions\DetachRelationship::class => Descriptors\Requests\DetachRelationship::class,
Controllers\Actions\UpdateRelationship::class => Descriptors\Requests\UpdateRelationship::class,
Controllers\Actions\Store::class => Descriptors\Requests\Store::class,
Controllers\Actions\Update::class => Descriptors\Requests\Update::class,
Controllers\Actions\AttachRelationship::class => Descriptors\Requests\AttachRelationship::class,
Controllers\Actions\DetachRelationship::class => Descriptors\Requests\DetachRelationship::class,
Controllers\Actions\UpdateRelationship::class => Descriptors\Requests\UpdateRelationship::class,
];

public function __construct(
Generator $generator,
SchemaBuilder $schemaBuilder
Generator $generator,
SchemaBuilder $schemaBuilder
) {
parent::__construct($generator);
$this->schemaBuilder = $schemaBuilder;
Expand All @@ -39,9 +39,9 @@ public function build(Route $route): ?RequestBody
}

/**
* @param \LaravelJsonApi\OpenApiSpec\Route $route
* @param Route $route
*
* @return \LaravelJsonApi\OpenApiSpec\Descriptors\Actions\ActionDescriptor|null
* @return Descriptors\Actions\ActionDescriptor|null
*/
protected function getDescriptor(Route $route): ?RequestDescriptor
{
Expand Down
206 changes: 103 additions & 103 deletions src/Builders/Paths/Operation/ResponseBuilder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,22 @@ class ResponseBuilder extends Builder
protected Schema $jsonapi;

protected array $descriptors = [
Actions\FetchMany::class => Responses\FetchMany::class,
Actions\FetchOne::class => Responses\FetchOne::class,
Actions\Store::class => Responses\FetchOne::class,
Actions\Update::class => Responses\FetchOne::class,
Actions\Destroy::class => Responses\Destroy::class,
Actions\FetchRelated::class => Responses\FetchRelated::class,
Actions\AttachRelationship::class => Responses\AttachRelationship::class,
Actions\DetachRelationship::class => Responses\DetachRelationship::class,
Actions\FetchRelationship::class => Responses\FetchRelation::class,
Actions\UpdateRelationship::class => Responses\UpdateRelationship::class,
Actions\FetchMany::class => Responses\FetchMany::class,
Actions\FetchOne::class => Responses\FetchOne::class,
Actions\Store::class => Responses\FetchOne::class,
Actions\Update::class => Responses\FetchOne::class,
Actions\Destroy::class => Responses\Destroy::class,
Actions\FetchRelated::class => Responses\FetchRelated::class,
Actions\AttachRelationship::class => Responses\AttachRelationship::class,
Actions\DetachRelationship::class => Responses\DetachRelationship::class,
Actions\FetchRelationship::class => Responses\FetchRelation::class,
Actions\UpdateRelationship::class => Responses\UpdateRelationship::class,
];

public function __construct(
Generator $generator,
ComponentsContainer $components,
SchemaBuilder $schemaBuilder
Generator $generator,
ComponentsContainer $components,
SchemaBuilder $schemaBuilder
) {
parent::__construct($generator);
$this->components = $components;
Expand All @@ -63,18 +63,18 @@ public function build(Route $route): array
}

/**
* @param \GoldSpecDigital\ObjectOrientedOAS\Objects\Schema $data
* @param \GoldSpecDigital\ObjectOrientedOAS\Objects\Schema|null $meta
* @param \GoldSpecDigital\ObjectOrientedOAS\Objects\Schema|null $links
* @param Schema $data
* @param Schema|null $meta
* @param Schema|null $links
*
* @throws \GoldSpecDigital\ObjectOrientedOAS\Exceptions\InvalidArgumentException
*
* @return \GoldSpecDigital\ObjectOrientedOAS\Objects\Schema
* @return Schema
*/
public static function buildResponse(
SchemaContract $data,
Schema $meta = null,
Schema $links = null
SchemaContract $data,
?Schema $meta = null,
?Schema $links = null
): Schema {
$jsonapi = Schema::object('jsonapi')
->properties(Schema::string('version')
Expand All @@ -91,7 +91,7 @@ public static function buildResponse(
}

/**
* @param \LaravelJsonApi\OpenApiSpec\Route $route
* @param Route $route
*
* @return \LaravelJsonApi\OpenApiSpec\Descriptors\Actions\ActionDescriptor|null
*/
Expand Down Expand Up @@ -142,88 +142,88 @@ protected function addDefaults(): void
);
$errorBody = Schema::object()->properties($this->jsonapi, $errors);
$this->defaults = collect([
Response::badRequest('400')
->description('Bad request')
->content(
MediaType::create()
->mediaType(MediaTypeInterface::JSON_API_MEDIA_TYPE)
->schema($errorBody)
->examples(Example::create('-')->value([
'jsonapi' => [
'version' => '1.0',
],
'errors' => [
[
'detail' => 'The member id is required.',
'source' => ['pointer' => '/data'],
'status' => '400',
'title' => 'Non-Compliant JSON:API Document',
],
],
])
)
),
Response::unauthorized('401')
->description('Unauthorized Action')
->content(
MediaType::create()
->mediaType(MediaTypeInterface::JSON_API_MEDIA_TYPE)
->schema($errorBody)
->examples(Example::create('-')->value([
'jsonapi' => [
'version' => '1.0',
],
'errors' => [
[
'title' => 'Unauthorized.',
'status' => '401',
'detail' => 'Unauthenticated.',
],
],
])
)
),
Response::notFound('404')
->description('Content Not Found')
->content(
MediaType::create()
->mediaType(MediaTypeInterface::JSON_API_MEDIA_TYPE)
->schema($errorBody)
->examples(Example::create('-')->value([
'jsonapi' => [
'version' => '1.0',
],
'errors' => [
[
'title' => 'Not Found',
'status' => '404',
],
],
])
)
),
Response::unprocessableEntity('422')
->statusCode(422)
->description('Unprocessable Entity')
->content(
MediaType::create()
->mediaType(MediaTypeInterface::JSON_API_MEDIA_TYPE)
->schema($errorBody)
->examples(Example::create('-')->value([
'jsonapi' => [
'version' => '1.0',
],
'errors' => [
[
'detail' => 'Lorem Ipsum',
'source' => ['pointer' => '/data/attributes/lorem'],
'title' => 'Unprocessable Entity',
'status' => '422',
],
],
])
)
),
Response::badRequest('400')
->description('Bad request')
->content(
MediaType::create()
->mediaType(MediaTypeInterface::JSON_API_MEDIA_TYPE)
->schema($errorBody)
->examples(Example::create('-')->value([
'jsonapi' => [
'version' => '1.0',
],
'errors' => [
[
'detail' => 'The member id is required.',
'source' => ['pointer' => '/data'],
'status' => '400',
'title' => 'Non-Compliant JSON:API Document',
],
],
])
)
),
Response::unauthorized('401')
->description('Unauthorized Action')
->content(
MediaType::create()
->mediaType(MediaTypeInterface::JSON_API_MEDIA_TYPE)
->schema($errorBody)
->examples(Example::create('-')->value([
'jsonapi' => [
'version' => '1.0',
],
'errors' => [
[
'title' => 'Unauthorized.',
'status' => '401',
'detail' => 'Unauthenticated.',
],
],
])
)
),
Response::notFound('404')
->description('Content Not Found')
->content(
MediaType::create()
->mediaType(MediaTypeInterface::JSON_API_MEDIA_TYPE)
->schema($errorBody)
->examples(Example::create('-')->value([
'jsonapi' => [
'version' => '1.0',
],
'errors' => [
[
'title' => 'Not Found',
'status' => '404',
],
],
])
)
),
Response::unprocessableEntity('422')
->statusCode(422)
->description('Unprocessable Entity')
->content(
MediaType::create()
->mediaType(MediaTypeInterface::JSON_API_MEDIA_TYPE)
->schema($errorBody)
->examples(Example::create('-')->value([
'jsonapi' => [
'version' => '1.0',
],
'errors' => [
[
'detail' => 'Lorem Ipsum',
'source' => ['pointer' => '/data/attributes/lorem'],
'title' => 'Unprocessable Entity',
'status' => '422',
],
],
])
)
),
])
->mapWithKeys(function (Response $response) {
$ref = $this->components->addResponse($response);
Expand Down
Loading

0 comments on commit 1e4ba71

Please sign in to comment.