3.1-3.6: install l5-swagger, add @OA annotations to all controllers
Deploy Backend / deploy (push) Failing after 2m16s
Deploy Backend / deploy (push) Failing after 2m16s
This commit is contained in:
1 parent
37dd2c9d54
commit
a4025256d4
13 files changed
+1367
-73
No files matched your search
@@ -7,26 +7,65 @@ use App\Http\Requests\Website\StoreAboutMeRequest;
|
||||
use App\Http\Requests\Website\UpdateAboutMeRequest;
|
||||
use App\Models\Website\AboutMe;
|
||||
|
||||
/**
|
||||
* @OA\Tag(name="About Me", description="About Me section endpoints")
|
||||
*/
|
||||
class AboutMeController extends Controller
|
||||
{
|
||||
/**
|
||||
* @OA\Get(
|
||||
* path="/website/about-me",
|
||||
* tags={"About Me"},
|
||||
* summary="Get the first About Me entry with skills",
|
||||
* @OA\Response(response=200, description="OK", @OA\JsonContent(ref="#/components/schemas/AboutMe"))
|
||||
* )
|
||||
*/
|
||||
public function index()
|
||||
{
|
||||
$aboutMe = AboutMe::with('skills')->first();
|
||||
return response()->json($aboutMe);
|
||||
}
|
||||
|
||||
/**
|
||||
* @OA\Get(
|
||||
* path="/website/about-me/{id}",
|
||||
* tags={"About Me"},
|
||||
* summary="Get a specific About Me entry",
|
||||
* @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
|
||||
* @OA\Response(response=200, description="OK")
|
||||
* )
|
||||
*/
|
||||
public function show($id)
|
||||
{
|
||||
$aboutMe = AboutMe::with('skills')->findOrFail($id);
|
||||
return response()->json($aboutMe);
|
||||
}
|
||||
|
||||
/**
|
||||
* @OA\Post(
|
||||
* path="/website/about-me",
|
||||
* tags={"About Me"},
|
||||
* summary="Create an About Me entry",
|
||||
* @OA\RequestBody(@OA\MediaType(mediaType="application/json")),
|
||||
* @OA\Response(response=201, description="Created")
|
||||
* )
|
||||
*/
|
||||
public function store(StoreAboutMeRequest $request)
|
||||
{
|
||||
$aboutMe = AboutMe::create($request->validated());
|
||||
return response()->json($aboutMe, 201);
|
||||
}
|
||||
|
||||
/**
|
||||
* @OA\Put(
|
||||
* path="/website/about-me/{id}",
|
||||
* tags={"About Me"},
|
||||
* summary="Update an About Me entry",
|
||||
* @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
|
||||
* @OA\RequestBody(@OA\MediaType(mediaType="application/json")),
|
||||
* @OA\Response(response=200, description="OK")
|
||||
* )
|
||||
*/
|
||||
public function update(UpdateAboutMeRequest $request, $id)
|
||||
{
|
||||
$aboutMe = AboutMe::findOrFail($id);
|
||||
@@ -34,12 +73,32 @@ class AboutMeController extends Controller
|
||||
return response()->json($aboutMe);
|
||||
}
|
||||
|
||||
/**
|
||||
* @OA\Delete(
|
||||
* path="/website/about-me/{id}",
|
||||
* tags={"About Me"},
|
||||
* summary="Delete an About Me entry",
|
||||
* @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
|
||||
* @OA\Response(response=204, description="No Content")
|
||||
* )
|
||||
*/
|
||||
public function destroy($id)
|
||||
{
|
||||
AboutMe::destroy($id);
|
||||
return response()->json(null, 204);
|
||||
}
|
||||
|
||||
/**
|
||||
* @OA\Get(
|
||||
* path="/website/about-me/{id}/translation/{locale}",
|
||||
* tags={"About Me"},
|
||||
* summary="Get localized About Me with skills",
|
||||
* @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
|
||||
* @OA\Parameter(name="locale", in="path", required=true, @OA\Schema(type="string", enum={"fa","en"})),
|
||||
* @OA\Response(response=200, description="OK", @OA\JsonContent(ref="#/components/schemas/AboutMe")),
|
||||
* @OA\Response(response=404, description="Translation not found")
|
||||
* )
|
||||
*/
|
||||
public function getTranslation($id, $locale)
|
||||
{
|
||||
$aboutMe = AboutMe::with('skills')->findOrFail($id);
|
||||
|
||||
Reference in new issue
Block a user