<?php

namespace App\PackagesApi\Docs\v3;

class FriendApiDoc extends AbstractV3Doc
{

    public static function endPoints()
    {
        return [
            'title' => 'Friends',
            'endpoints' => [
                [
                    'title' => 'Get Friends count',
                    'desc' => '',

                    'route' => route('friends.count'),
                    'method' => 'GET',
                    'headers' => self::middlewareHeaders(),
                    'body' => '',

                    'response' => [

                        200 => [
                            'headers' => self::responseHeaders(),
                            'body' => [
                                'success' => true,
                                'friend_count' => 3
                            ],
                        ]
                    ],
                ],

                [
                    'title' => 'Get Friends list',
                    'desc' => '',

                    'route' => route('friends.list'),
                    'method' => 'GET',
                    'headers' => self::middlewareHeaders(),
                    'body' => '',

                    'parameters' => [
                        [
                            'name' => 'user_id',
                            'desc' => 'User ID'
                        ]
                    ],

                    'response' => [

                        200 => [
                            'headers' => self::responseHeaders(),
                            'body' => [
                                'success' => true,
                                'friends' => [
                                    [
                                        'id' => "ac84fda7-f30d-4a9d-92cf-bc16c6a65d5e",
                                        'name' => "Тимур80",
                                        'image_url' => "https://api.timehook.local/samples/avatar/9.png"
                                    ]
                                ]
                            ],
                        ]
                    ],
                ],

                [
                    'title' => 'Remove friend / Un friend',
                    'desc' => '',

                    'route' => route('friends.remove'),
                    'method' => 'POST',
                    'headers' => self::middlewareHeaders(),
                    'body' => [
                        'user_id' => 'ac84fda7-f30d-4a9d-92cf-bc16c6a65d5e'
                    ],

                    'response' => [

                        200 => [
                            'headers' => self::responseHeaders(),
                            'body' => [
                                'success' => true,
                                'message' => 'Success removed friend'
                            ],
                        ]
                    ],
                ],
            ]
        ];
    }

}