|
| | $modelName = 'App\Models\DepartmentModel' |
| |
| | $format = 'json' |
| |
| path | : "/api/departments" |
| | HTTP-spezifischer Kontext.
|
| |
| path | tags: ["Departments"] |
| |
| path | summary: "Retrieve all departments with manager and parent details" |
| |
| path | responses: [ new OA\Response( response: 200 |
| |
| path | description: "List of departments retrieved successfully" |
| |
| path | content: new OA\JsonContent( properties: [ new OA\Property(property: "status" |
| |
| path | type: "string" |
| |
| path | example: "success") |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index() | path: "/api/departments/{id}" |
| | HTTP-spezifischer Kontext.
|
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | tags: ["Departments"] |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | summary: "Retrieve a specific department by ID" |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | parameters: [ new OA\Parameter( name: "id" |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | in: "path" |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | required: true |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | description: "ID of the department" |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | schema: new OA\Schema(type: "integer" |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | example: 1) ) ] |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | responses: [ new OA\Response( response: 200 |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | content: new OA\JsonContent( properties: [ new OA\Property(property: "status" |
| |
| path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index | type: "string" |
| |