UserSwagger.php

<?php

namespace App\Api\Swagger\User;

use Illuminate\Http\Response;
use OpenApi\Annotations\JsonContent;
use OpenApi\Annotations\Property;
use OpenApi\Attributes as OA;

trait UserSwagger
{
    #[
        OA\Get(
            path: '/users',
            operationId: 'getUsersList',
            summary: 'Get List of users',
            description: 'Returns list of users',
            tags: ['Users'],
            security: [
                [
                    'bearerAuth' => []
                ]
            ],
            requestBody: new OA\RequestBody(
                content: new OA\MediaType(
                    mediaType: 'application/json',

                )
            ),
            responses: [

                new OA\Response(response: Response::HTTP_OK,  description: 'Successful operation'),
                new OA\Response(response: Response::HTTP_UNAUTHORIZED,  description: 'Unauthenticated'),
                new OA\Response(response: Response::HTTP_FORBIDDEN,  description: 'Forbidden'),
            ]
        )
    ]
    private function all(): void
    {
    }

    #[
        OA\Get(
            path: '/users/{id}',
            operationId: 'showUser',
            summary: 'Show a specific user',
            description: 'Returns a specific user',
            tags: ['Users'],
            security: [
                [
                    'bearerAuth' => []
                ]
            ],
            parameters: [new OA\Parameter(name: 'id', in: 'path', required: true, description: 'User ID')],
            responses: [
                new OA\Response(response: Response::HTTP_OK,  description: 'Successful operation'),
                new OA\Response(response: Response::HTTP_UNAUTHORIZED,  description: 'Unauthenticated'),
                new OA\Response(response: Response::HTTP_FORBIDDEN,  description: 'Forbidden'),
            ]
        )
    ]
    private function swagger_show(): void
    {
    }

    #[
        OA\Post(
            path: 'users',
            operationId: 'storeUser',
            summary: 'Store a new user',
            description: 'Stores a new user',
            tags: ['Users'],
            security: [
                [
                    'bearerAuth' => []
                ]
            ],
            requestBody: new OA\RequestBody(
                required: true,
                content: new OA\MediaType(
                    mediaType: 'application/json',
                    schema: new OA\Schema(
                        required: ['name', 'email', 'password', 'password_confirmation'],
                        properties: [
                            new OA\Property(property: 'name', type: 'string'),
                            new OA\Property(property: 'email', type: 'string'),
                            new OA\Property(property: 'password', type: 'string'),
                            new OA\Property(property: 'password_confirmation', type: 'string'),
                        ]
                    ),
                    example: [
                        "name" => "John Doe",
                        "email" => "example@elevensoft.dev",
                        "password" => "password",
                        "password_confirmation" => "password",
                    ]
                )
            ),
            responses: [
                new OA\Response(response: Response::HTTP_OK,  description: 'Successful operation'),
                new OA\Response(response: Response::HTTP_UNAUTHORIZED,  description: 'Unauthenticated'),
                new OA\Response(response: Response::HTTP_FORBIDDEN,  description: 'Forbidden'),
            ]
        )
    ]
    private function swagger_store(): void
    {
    }
    #[
        OA\Put(
            path: 'users/{id}',
            operationId: 'updateUser',
            summary: 'Update a specific user',
            description: "Updates a specific user",
            tags: ['Users'],
            security: [
                [
                    'bearerAuth' => []
                ]
            ],
            parameters: [new OA\Parameter(name: 'id', in: 'path', required: true, description: 'User ID')],
            requestBody: new OA\RequestBody(
                required: true,
                content: new OA\MediaType(
                    mediaType: 'application/json',
                    schema: new OA\Schema(
                        required: ['name', 'email'],
                        properties: [
                            new OA\Property(property: 'name', type: 'string'),
                            new OA\Property(property: 'email', type: 'string'),
                            new OA\Property(property: 'password', type: 'string'),
                            new OA\Property(property: 'password_confirmation', type: 'string'),
                        ]
                    ),
                    example: [
                        "name" => "John Doe",
                        "email" => "example@elevensoft.dev",
                        "password" => "password",
                        "password_confirmation" => "password",
                    ]
                )


            ),
            responses: [
                new OA\Response(response: Response::HTTP_OK,  description: 'Successful operation'),
                new OA\Response(response: Response::HTTP_UNAUTHORIZED,  description: 'Unauthenticated'),
                new OA\Response(response: Response::HTTP_FORBIDDEN,  description: 'Forbidden'),
            ]
        )
    ]
    private function swagger_update(): void
    {
    }

    #[
        OA\Delete(
            path: '/users/{id}',
            operationId: 'deleteUser',
            summary: 'Delete a specific user',
            description: 'Deletes a specific user',
            tags: ['Users'],
            security: [
                [
                    'bearerAuth' => []
                ]
            ],
            parameters: [new OA\Parameter(name: 'id', in: 'path', required: true, description: 'User ID')],
            responses: [
                new OA\Response(response: Response::HTTP_OK,  description: 'Successful operation'),
                new OA\Response(response: Response::HTTP_UNAUTHORIZED,  description: 'Unauthenticated'),
                new OA\Response(response: Response::HTTP_FORBIDDEN,  description: 'Forbidden'),
            ]
        )
    ]
    private function swagger_delete(): void
    {
    }
}