{ "openapi": "3.1.0", "info": { "title": "MedConnect API", "version": "1.0.0", "description": "Generated from Laravel route map." }, "servers": [ { "url": "http://localhost" } ], "tags": [ { "name": "Identity" }, { "name": "Organization" }, { "name": "Shared" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "token" }, "CompanyContextHeader": { "type": "apiKey", "in": "header", "name": "X-Company-Context", "description": "Required for company-scoped protected requests." } }, "schemas": { "ApiSuccess": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string" }, "data": { "type": "object", "additionalProperties": true } } }, "ApiError": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": true } } } } }, "paths": { "/api/audit/bulk": { "post": { "tags": [ "Shared" ], "operationId": "userAuditControllerBulkPOST", "summary": "Bulk", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "audit.bulk", "x-action": "App\\Domains\\Shared\\Controllers\\UserAuditController@bulk", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:system.audit_logs.view_company|system.audit_logs.view_users|system.audit_logs.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "system.audit_logs.view", "system.audit_logs.view_company", "system.audit_logs.view_users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_ids": { "type": "array", "items": { "type": "integer" } }, "page": { "type": "integer" }, "per_page": { "type": "integer" } } }, "example": { "user_ids": [ 12, 15, 18 ], "page": 1, "per_page": 25 } } } } } }, "/api/audit/events": { "get": { "tags": [ "Shared" ], "operationId": "userAuditControllerEventsGET", "summary": "Events", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "domain": { "type": "string" }, "event": { "type": "string" }, "description": { "type": "string" }, "subject_type": { "type": "string" }, "subject_id": { "type": "integer" }, "subject": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "name": { "type": "null" } } }, "causer": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "properties": { "type": "object", "properties": { "old_values": { "type": "array", "items": { "type": "null" } }, "attributes": { "type": "object", "properties": { "name": { "type": "string" } } }, "ip_address": { "type": "string" }, "user_agent": { "type": "string" }, "subject_type": { "type": "string" }, "subject_id": { "type": "integer" }, "url": { "type": "string" } } }, "tags": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } }, "available_filters": { "type": "object", "properties": { "event_types": { "type": "array", "items": { "type": "string" } }, "domains": { "type": "array", "items": { "type": "string" } }, "subject_types": { "type": "array", "items": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "events": [ { "id": 6101, "domain": "organization", "event": "organization.department.created", "description": "Organization.department.created Department", "subject_type": "Department", "subject_id": 44, "subject": { "id": 44, "type": "Department", "name": null }, "causer": { "id": 1, "name": "System Super Admin", "email": "superadmin@medconnect.local" }, "properties": { "old_values": [], "attributes": { "name": "Operations" }, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0", "subject_type": "Department", "subject_id": 44, "url": "http://localhost:8000/api/departments" }, "tags": [ "company:1", "domain:organization" ], "created_at": "2026-02-18T12:00:00Z" } ], "pagination": { "current_page": 1, "last_page": 1, "per_page": 20, "total": 1 }, "available_filters": { "event_types": [ "organization.department.created", "shared.company.updated" ], "domains": [ "identity", "organization", "shared", "auth" ], "subject_types": [ "Company", "Department", "Position", "User" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "audit.events", "x-action": "App\\Domains\\Shared\\Controllers\\UserAuditController@events", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:system.audit_logs.view_company|system.audit_logs.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "system.audit_logs.view", "system.audit_logs.view_company" ] } }, "/api/audit/events/export": { "get": { "tags": [ "Shared" ], "operationId": "userAuditControllerExportEventsGET", "summary": "Export Events", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "audit.events.export", "x-action": "App\\Domains\\Shared\\Controllers\\UserAuditController@exportEvents", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:system.audit_logs.export|system.audit_logs.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "system.audit_logs.export", "system.audit_logs.view" ] } }, "/api/audit/statistics": { "get": { "tags": [ "Shared" ], "operationId": "userAuditControllerStatisticsGET", "summary": "Statistics", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "total_events": { "type": "integer" }, "events_today": { "type": "integer" }, "most_active_users": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "integer" }, "count": { "type": "integer" } } } } } } } }, "example": { "success": true, "data": { "total_events": 150, "events_today": 12, "most_active_users": [ { "user_id": 1, "count": 40 } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "audit.statistics", "x-action": "App\\Domains\\Shared\\Controllers\\UserAuditController@statistics", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:system.audit_logs.view_company|system.audit_logs.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "system.audit_logs.view", "system.audit_logs.view_company" ] } }, "/api/audit/users": { "get": { "tags": [ "Shared" ], "operationId": "userAuditControllerUsersGET", "summary": "Users", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "audit_trail": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "event": { "type": "string" }, "user_id": { "type": "integer" }, "company_id": { "type": "integer" }, "old_values": { "type": "array", "items": { "type": "null" } }, "new_values": { "type": "object", "properties": { "name": { "type": "string" } } }, "created_at": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "audit_trail": [ { "id": 5001, "event": "identity.user.created", "user_id": 1, "company_id": 1, "old_values": [], "new_values": { "name": "User One" }, "created_at": "2026-02-18T12:00:00Z" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "audit.users", "x-action": "App\\Domains\\Shared\\Controllers\\UserAuditController@users", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:system.audit_logs.view_company|system.audit_logs.view_users|system.audit_logs.view_own|system.audit_logs.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "system.audit_logs.view", "system.audit_logs.view_company", "system.audit_logs.view_own", "system.audit_logs.view_users" ] } }, "/api/audit/users/{user}": { "get": { "tags": [ "Shared" ], "operationId": "userAuditControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "audit_trail": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "event": { "type": "string" }, "user_id": { "type": "integer" }, "company_id": { "type": "integer" }, "old_values": { "type": "array", "items": { "type": "null" } }, "new_values": { "type": "object", "properties": { "name": { "type": "string" } } }, "created_at": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "audit_trail": [ { "id": 5001, "event": "identity.user.created", "user_id": 1, "company_id": 1, "old_values": [], "new_values": { "name": "User One" }, "created_at": "2026-02-18T12:00:00Z" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "audit.users.show", "x-action": "App\\Domains\\Shared\\Controllers\\UserAuditController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:system.audit_logs.view_company|system.audit_logs.view_users|system.audit_logs.view_own|system.audit_logs.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "system.audit_logs.view", "system.audit_logs.view_company", "system.audit_logs.view_own", "system.audit_logs.view_users" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/audit/users/{user}/export": { "get": { "tags": [ "Shared" ], "operationId": "userAuditControllerExportGET", "summary": "Export", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "audit.users.export", "x-action": "App\\Domains\\Shared\\Controllers\\UserAuditController@export", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:system.audit_logs.export|system.audit_logs.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "system.audit_logs.export", "system.audit_logs.view" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/auth/bootstrap": { "get": { "tags": [ "Identity" ], "operationId": "authControllerBootstrapGET", "summary": "Bootstrap", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "current_company": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" } } }, "authorization": { "type": "object", "properties": { "role": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "user": { "id": 1, "name": "System Super Admin", "email": "superadmin@medconnect.local" }, "current_company": { "id": 1, "name": "Acme Medical", "code": "ACME" }, "authorization": { "role": "super_admin", "permissions": [ "users.view", "users.create", "roles.view" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@bootstrap", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/auth/capabilities": { "get": { "tags": [ "Identity" ], "operationId": "authControllerCapabilitiesGET", "summary": "Capabilities", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "auth": { "type": "object", "properties": { "methods": { "type": "object", "properties": { "email_password": { "type": "boolean" }, "sms": { "type": "boolean" }, "social": { "type": "boolean" } } }, "refresh_token_rotation": { "type": "boolean" } } }, "company_context": { "type": "object", "properties": { "header": { "type": "string" }, "required_for_protected_requests": { "type": "boolean" }, "current_company_id": { "type": "integer" } } }, "domains": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "permissions_total": { "type": "integer" }, "permissions_granted": { "type": "integer" }, "enabled_for_user": { "type": "boolean" } } } } } } } }, "example": { "success": true, "data": { "auth": { "methods": { "email_password": true, "sms": false, "social": false }, "refresh_token_rotation": true }, "company_context": { "header": "X-Company-Context", "required_for_protected_requests": true, "current_company_id": 1 }, "domains": [ { "key": "identity", "permissions_total": 25, "permissions_granted": 25, "enabled_for_user": true } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@capabilities", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/auth/change-password": { "put": { "tags": [ "Identity" ], "operationId": "authControllerChangePasswordPUT", "summary": "Change Password", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@changePassword", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "current_password": { "type": "string" }, "password": { "type": "string" }, "password_confirmation": { "type": "string" } } }, "example": { "current_password": "OldPassword123!", "password": "NewPassword123!", "password_confirmation": "NewPassword123!" } } } } } }, "/api/auth/company/check-access": { "post": { "tags": [ "Identity" ], "operationId": "authControllerCheckCompanyAccessPOST", "summary": "Check Company Access", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@checkCompanyAccess", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "company_id": { "type": "integer" } } }, "example": { "company_id": 1 } } } } } }, "/api/auth/company/current": { "get": { "tags": [ "Identity" ], "operationId": "authControllerGetCurrentCompanyContextGET", "summary": "Get Current Company Context", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "company": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "logo_url": { "type": "null" } } }, "user_role": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "company_settings": { "type": "object", "properties": { "timezone": { "type": "string" }, "date_format": { "type": "string" }, "currency": { "type": "string" } } } } } } }, "example": { "success": true, "data": { "company": { "id": 1, "name": "Acme Medical", "code": "ACME", "logo_url": null }, "user_role": "super_admin", "permissions": [ "users.view", "roles.view" ], "company_settings": { "timezone": "UTC", "date_format": "Y-m-d", "currency": "USD" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@getCurrentCompanyContext", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/auth/company/list": { "get": { "tags": [ "Identity" ], "operationId": "authControllerGetUserCompaniesGET", "summary": "Get User Companies", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "role": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "is_current": { "type": "boolean" } } } }, "current_company_id": { "type": "integer" } } } } }, "example": { "success": true, "data": { "companies": [ { "id": 1, "name": "Acme Medical", "code": "ACME", "role": "super_admin", "permissions": [ "users.view", "roles.view" ], "is_current": true }, { "id": 2, "name": "Beta Clinic", "code": "BETA", "role": "company_admin", "permissions": [ "users.view" ], "is_current": false } ], "current_company_id": 1 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@getUserCompanies", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/auth/company/switch": { "post": { "tags": [ "Identity" ], "operationId": "authControllerSwitchCompanyPOST", "summary": "Switch Company", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "stateless": { "type": "boolean" }, "company_context_header": { "type": "integer" }, "current_company": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" } } }, "user_role": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "message": "Company context validated. Include this company ID in Company-Context header for each request.", "data": { "stateless": true, "company_context_header": 2, "current_company": { "id": 2, "name": "Beta Clinic", "code": "BETA" }, "user_role": "company_admin", "permissions": [ "users.view", "users.create" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@switchCompany", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "company_id": { "type": "integer" } } }, "example": { "company_id": 1 } } } } } }, "/api/auth/company/{companyId}/access": { "get": { "tags": [ "Identity" ], "operationId": "authControllerCheckCompanyAccessByPathGET", "summary": "Check Company Access By Path", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@checkCompanyAccessByPath", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/auth/forgot-password": { "post": { "tags": [ "Identity" ], "operationId": "authControllerForgotPasswordPOST", "summary": "Forgot Password", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@forgotPassword", "x-middleware": [ "api" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" } } }, "example": { "email": "user@example.com" } } } } } }, "/api/auth/login": { "post": { "tags": [ "Identity" ], "operationId": "authControllerLoginPOST", "summary": "Login", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" }, "current_company": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" } } } } }, "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer" } } } } }, "example": { "success": true, "message": "Login successful", "data": { "user": { "id": 1, "name": "System Super Admin", "email": "superadmin@medconnect.local", "current_company": { "id": 1, "name": "Acme Medical", "code": "ACME" } }, "access_token": "1|access_token_value", "refresh_token": "rtkn_example_long_random_value", "token_type": "Bearer", "expires_in": 3600 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@login", "x-middleware": [ "api" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "example": { "email": "admin@example.com", "password": "Password123!" } } } } } }, "/api/auth/logout": { "post": { "tags": [ "Identity" ], "operationId": "authControllerLogoutPOST", "summary": "Logout", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@logout", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "refresh_token": { "type": "string" } } }, "example": { "refresh_token": "rtkn_example_long_random_value" } } } } } }, "/api/auth/logout-all": { "post": { "tags": [ "Identity" ], "operationId": "authControllerLogoutAllPOST", "summary": "Logout All", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@logoutAll", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/auth/me": { "get": { "tags": [ "Identity" ], "operationId": "authControllerMeGET", "summary": "Me", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" } } } } } } }, "example": { "success": true, "data": { "user": { "id": 1, "name": "System Super Admin", "email": "superadmin@medconnect.local" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@me", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/auth/profile": { "put": { "tags": [ "Identity" ], "operationId": "authControllerUpdateProfilePUT", "summary": "Update Profile", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@updateProfile", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/auth/refresh": { "post": { "tags": [ "Identity" ], "operationId": "authControllerRefreshPOST", "summary": "Refresh", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer" } } } } }, "example": { "success": true, "message": "Token refreshed successfully", "data": { "access_token": "2|rotated_access_token_value", "refresh_token": "rtkn_rotated_value", "token_type": "Bearer", "expires_in": 3600 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@refresh", "x-middleware": [ "api" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "refresh_token": { "type": "string" } } }, "example": { "refresh_token": "rtkn_example_long_random_value" } } } } } }, "/api/auth/reset-password": { "post": { "tags": [ "Identity" ], "operationId": "authControllerResetPasswordPOST", "summary": "Reset Password", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@resetPassword", "x-middleware": [ "api" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "token": { "type": "string" }, "password": { "type": "string" }, "password_confirmation": { "type": "string" } } }, "example": { "email": "user@example.com", "token": "reset-token-value", "password": "NewPassword123!", "password_confirmation": "NewPassword123!" } } } } } }, "/api/auth/tokens": { "delete": { "tags": [ "Identity" ], "operationId": "authControllerRevokeTokenDELETE", "summary": "Revoke Token", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@revokeToken", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "get": { "tags": [ "Identity" ], "operationId": "authControllerTokensGET", "summary": "Tokens", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@tokens", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/auth/verify-password": { "post": { "tags": [ "Identity" ], "operationId": "authControllerVerifyPasswordPOST", "summary": "Verify Password", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\AuthController@verifyPassword", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string" } } }, "example": { "password": "Password123!" } } } } } }, "/api/breadcrumbs": { "post": { "tags": [ "Shared" ], "operationId": "navigationControllerGetBreadcrumbsPOST", "summary": "Get Breadcrumbs", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "api.navigation.breadcrumbs", "x-action": "App\\Domains\\Shared\\Controllers\\NavigationController@getBreadcrumbs", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "path": { "type": "string" } } }, "example": { "path": "/users/12" } } } } } }, "/api/broadcasting/auth": { "post": { "tags": [ "Shared" ], "operationId": "routePOSTApiBroadcastingAuth", "summary": "POST /api/broadcasting/auth", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "Closure", "x-middleware": [ "api", "auth:sanctum" ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/check-permission": { "post": { "tags": [ "Shared" ], "operationId": "navigationControllerCheckPermissionPOST", "summary": "Check Permission", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permission": { "type": "string" }, "allowed": { "type": "boolean" } } } } }, "example": { "success": true, "data": { "permission": "users.view", "allowed": true } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "api.navigation.check-permission", "x-action": "App\\Domains\\Shared\\Controllers\\NavigationController@checkPermission", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "permission": { "type": "string" } } }, "example": { "permission": "users.view" } } } } } }, "/api/companies": { "get": { "tags": [ "Shared" ], "operationId": "companyControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "companies": [ { "id": 1, "name": "Acme Medical", "code": "ACME" }, { "id": 2, "name": "Beta Clinic", "code": "BETA" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Shared\\Controllers\\CompanyController@index", "x-middleware": [ "api", "auth:sanctum" ], "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "companyControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "company": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Company created successfully", "data": { "company": { "id": 3, "name": "Acme Medical", "code": "ACME" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Shared\\Controllers\\CompanyController@store", "x-middleware": [ "api", "auth:sanctum" ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "settings": { "type": "object", "properties": { "timezone": { "type": "string" }, "currency": { "type": "string" } } } } }, "example": { "name": "Acme Medical", "code": "ACME", "settings": { "timezone": "UTC", "currency": "USD" } } } } } } }, "/api/companies/{company}": { "delete": { "tags": [ "Shared" ], "operationId": "companyControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Shared\\Controllers\\CompanyController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:company.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "company.edit" ], "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "companyControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Shared\\Controllers\\CompanyController@show", "x-middleware": [ "api", "auth:sanctum" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "companyControllerUpdatePUT", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Shared\\Controllers\\CompanyController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:company.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "company.edit" ], "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "settings": { "type": "object", "properties": { "timezone": { "type": "string" }, "currency": { "type": "string" } } } } }, "example": { "name": "Acme Medical Updated", "settings": { "timezone": "UTC", "currency": "USD" } } } } } } }, "/api/companies/{company}/branding": { "post": { "tags": [ "Shared" ], "operationId": "companyControllerUpdateBrandingPOST", "summary": "Update Branding", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Shared\\Controllers\\CompanyController@updateBranding", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:company.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "company.edit" ], "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/companies/{company}/settings": { "put": { "tags": [ "Shared" ], "operationId": "companyControllerUpdateSettingsPUT", "summary": "Update Settings", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Shared\\Controllers\\CompanyController@updateSettings", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:company.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "company.edit" ], "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "settings": { "type": "object", "properties": { "timezone": { "type": "string" }, "currency": { "type": "string" } } } } }, "example": { "name": "Acme Medical Updated", "settings": { "timezone": "UTC", "currency": "USD" } } } } } } }, "/api/companies/{company}/users": { "get": { "tags": [ "Shared" ], "operationId": "companyControllerGetUserAccessSummaryGET", "summary": "Get User Access Summary", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Shared\\Controllers\\CompanyController@getUserAccessSummary", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.view" ], "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/departments": { "get": { "tags": [ "Organization" ], "operationId": "departmentManagementControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "departments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "parent_id": { "type": "null" }, "employees_count": { "type": "integer" } } } } } } } }, "example": { "success": true, "data": { "departments": [ { "id": 3, "name": "Operations", "code": "OPS", "parent_id": null, "employees_count": 12 } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "departments.index", "x-action": "App\\Domains\\Organization\\Controllers\\DepartmentManagementController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:departments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "departments.view" ] }, "post": { "tags": [ "Organization" ], "operationId": "departmentManagementControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "departments.store", "x-action": "App\\Domains\\Organization\\Controllers\\DepartmentManagementController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:departments.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "departments.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "parent_id": { "type": "null" }, "head_employee_id": { "type": "null" } } }, "example": { "name": "Operations", "code": "OPS", "parent_id": null, "head_employee_id": null } } } } } }, "/api/departments/hierarchy": { "get": { "tags": [ "Organization" ], "operationId": "departmentManagementControllerHierarchyGET", "summary": "Hierarchy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "departments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "parent_id": { "type": "null" }, "employees_count": { "type": "integer" } } } } } } } }, "example": { "success": true, "data": { "departments": [ { "id": 3, "name": "Operations", "code": "OPS", "parent_id": null, "employees_count": 12 } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "departments.hierarchy", "x-action": "App\\Domains\\Organization\\Controllers\\DepartmentManagementController@hierarchy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:departments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "departments.view" ] } }, "/api/departments/{department}": { "delete": { "tags": [ "Organization" ], "operationId": "departmentManagementControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "departments.destroy", "x-action": "App\\Domains\\Organization\\Controllers\\DepartmentManagementController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:departments.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "departments.delete" ], "parameters": [ { "name": "department", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Organization" ], "operationId": "departmentManagementControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "departments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "parent_id": { "type": "null" }, "employees_count": { "type": "integer" } } } } } } } }, "example": { "success": true, "data": { "departments": [ { "id": 3, "name": "Operations", "code": "OPS", "parent_id": null, "employees_count": 12 } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "departments.show", "x-action": "App\\Domains\\Organization\\Controllers\\DepartmentManagementController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:departments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "departments.view" ], "parameters": [ { "name": "department", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Organization" ], "operationId": "departmentManagementControllerUpdatePUT", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "departments.update", "x-action": "App\\Domains\\Organization\\Controllers\\DepartmentManagementController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:departments.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "departments.edit" ], "parameters": [ { "name": "department", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "head_employee_id": { "type": "integer" } } }, "example": { "name": "Operations and Logistics", "head_employee_id": 20 } } } } } }, "/api/device-tokens": { "get": { "tags": [ "Shared" ], "operationId": "deviceTokenControllerListGET", "summary": "List", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "device-tokens.list", "x-action": "App\\Domains\\Shared\\Controllers\\DeviceTokenController@list", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/device-tokens/activity": { "post": { "tags": [ "Shared" ], "operationId": "deviceTokenControllerUpdateActivityPOST", "summary": "Update Activity", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "device-tokens.activity", "x-action": "App\\Domains\\Shared\\Controllers\\DeviceTokenController@updateActivity", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string" }, "last_seen_at": { "type": "string" } } }, "example": { "device_id": "ios-123456", "last_seen_at": "2026-02-18T10:00:00Z" } } } } } }, "/api/device-tokens/register": { "post": { "tags": [ "Shared" ], "operationId": "deviceTokenControllerRegisterPOST", "summary": "Register", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "device-tokens.register", "x-action": "App\\Domains\\Shared\\Controllers\\DeviceTokenController@register", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string" }, "platform": { "type": "string" }, "token": { "type": "string" } } }, "example": { "device_id": "ios-123456", "platform": "ios", "token": "expo_push_token_or_fcm_token_value" } } } } } }, "/api/device-tokens/unregister": { "post": { "tags": [ "Shared" ], "operationId": "deviceTokenControllerUnregisterPOST", "summary": "Unregister", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "device-tokens.unregister", "x-action": "App\\Domains\\Shared\\Controllers\\DeviceTokenController@unregister", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string" } } }, "example": { "device_id": "ios-123456" } } } } } }, "/api/device-tokens/{deviceId}": { "delete": { "tags": [ "Shared" ], "operationId": "deviceTokenControllerRemoveDELETE", "summary": "Remove", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "device-tokens.remove", "x-action": "App\\Domains\\Shared\\Controllers\\DeviceTokenController@remove", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/docs/openapi.json": { "get": { "tags": [ "Shared" ], "operationId": "routeGETApiDocsOpenapijson", "summary": "GET /api/docs/openapi.json", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "Closure", "x-middleware": [ "web" ] } }, "/api/docs/swagger": { "get": { "tags": [ "Shared" ], "operationId": "routeGETApiDocsSwagger", "summary": "GET /api/docs/swagger", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "Closure", "x-middleware": [ "web" ] } }, "/api/employees": { "get": { "tags": [ "Organization" ], "operationId": "employeeManagementControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "employees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "employee_code": { "type": "string" }, "department_id": { "type": "integer" }, "position_id": { "type": "integer" }, "status": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "employees": [ { "id": 20, "user_id": 12, "employee_code": "EMP-1450", "department_id": 3, "position_id": 5, "status": "active" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.index", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeManagementController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.view" ] } }, "/api/employees/{employee}": { "get": { "tags": [ "Organization" ], "operationId": "employeeManagementControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "employees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "employee_code": { "type": "string" }, "department_id": { "type": "integer" }, "position_id": { "type": "integer" }, "status": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "employees": [ { "id": 20, "user_id": 12, "employee_code": "EMP-1450", "department_id": 3, "position_id": 5, "status": "active" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.show", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeManagementController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Organization" ], "operationId": "employeeManagementControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.patch", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeManagementController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.edit" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_code": { "type": "string" }, "department_id": { "type": "integer" }, "position_id": { "type": "integer" }, "manager_id": { "type": "integer" } } }, "example": { "employee_code": "EMP-1450", "department_id": 3, "position_id": 5, "manager_id": 9 } } } } }, "put": { "tags": [ "Organization" ], "operationId": "employeeManagementControllerUpdatePUT", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.update", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeManagementController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.edit" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_code": { "type": "string" }, "department_id": { "type": "integer" }, "position_id": { "type": "integer" }, "manager_id": { "type": "integer" } } }, "example": { "employee_code": "EMP-1450", "department_id": 3, "position_id": 5, "manager_id": 9 } } } } } }, "/api/employees/{employee}/assignments": { "get": { "tags": [ "Organization" ], "operationId": "employeeManagementControllerAssignmentsGET", "summary": "Assignments", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "employees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "employee_code": { "type": "string" }, "department_id": { "type": "integer" }, "position_id": { "type": "integer" }, "status": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "employees": [ { "id": 20, "user_id": 12, "employee_code": "EMP-1450", "department_id": 3, "position_id": 5, "status": "active" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.assignments.index", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeManagementController@assignments", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Organization" ], "operationId": "employeeManagementControllerAssignPOST", "summary": "Assign", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.assignments.store", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeManagementController@assign", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.manage_hierarchy" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.manage_hierarchy" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "department_id": { "type": "integer" }, "position_id": { "type": "integer" }, "manager_id": { "type": "integer" }, "effective_date": { "type": "string" } } }, "example": { "department_id": 3, "position_id": 5, "manager_id": 9, "effective_date": "2026-02-18" } } } } } }, "/api/employees/{employee}/attachments": { "get": { "tags": [ "Organization" ], "operationId": "employeeAttachmentControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "employee": { "type": "object", "properties": { "id": { "type": "integer" }, "employee_code": { "type": "string" }, "name": { "type": "string" } } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "purpose": { "type": "string" }, "category": { "type": "string" }, "original_name": { "type": "string" }, "mime_type": { "type": "string" }, "size_bytes": { "type": "integer" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "uploaded_at": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "example": { "success": true, "data": { "employee": { "id": 33, "employee_code": "EMP-1001", "name": "John Employee" }, "attachments": [ { "id": 71, "uuid": "5ec5f6a9-97e7-4b7f-9ec4-c8d2d0e0f27a", "purpose": "organization", "category": "contracts", "original_name": "employee-contract.pdf", "mime_type": "application/pdf", "size_bytes": 245760, "status": "active", "visibility": "private", "uploaded_at": "2026-02-18T12:00:00Z" } ], "pagination": { "current_page": 1, "last_page": 1, "per_page": 20, "total": 1 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.attachments.index", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeAttachmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.attachments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.attachments.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/employees/{employee}/attachments/intents": { "post": { "tags": [ "Organization" ], "operationId": "employeeAttachmentControllerCreateIntentPOST", "summary": "Create Intent", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "employee": { "type": "object", "properties": { "id": { "type": "integer" }, "employee_code": { "type": "string" }, "name": { "type": "string" } } }, "attachment": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "status": { "type": "string" }, "purpose": { "type": "string" }, "category": { "type": "string" } } }, "upload": { "type": "object", "properties": { "mode": { "type": "string" }, "method": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": "array", "items": { "type": "null" } } } } } } } }, "example": { "success": true, "message": "Upload intent created", "data": { "employee": { "id": 33, "employee_code": "EMP-1001", "name": "John Employee" }, "attachment": { "id": 71, "uuid": "5ec5f6a9-97e7-4b7f-9ec4-c8d2d0e0f27a", "status": "pending", "purpose": "organization", "category": "contracts" }, "upload": { "mode": "server_multipart", "method": "POST", "url": "/api/employees/33/attachments/upload", "headers": [] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.attachments.intents.create", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeAttachmentController@createIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.attachments.upload" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.attachments.upload" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "original_name": { "type": "string" }, "mime_type": { "type": "string" }, "size_bytes": { "type": "integer" }, "purpose": { "type": "string" }, "category": { "type": "string" }, "visibility": { "type": "string" } } }, "example": { "original_name": "employee-contract.pdf", "mime_type": "application/pdf", "size_bytes": 245760, "purpose": "organization", "category": "contracts", "visibility": "private" } } } } } }, "/api/employees/{employee}/attachments/upload": { "post": { "tags": [ "Organization" ], "operationId": "employeeAttachmentControllerUploadPOST", "summary": "Upload", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "status": { "type": "string" }, "uploaded_at": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Attachment uploaded successfully", "data": { "attachment": { "id": 71, "uuid": "5ec5f6a9-97e7-4b7f-9ec4-c8d2d0e0f27a", "status": "active", "uploaded_at": "2026-02-18T12:05:00Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.attachments.upload", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeAttachmentController@upload", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.attachments.upload" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.attachments.upload" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "attachment_uuid", "file" ], "properties": { "attachment_uuid": { "type": "string", "format": "uuid" }, "file": { "type": "string", "format": "binary" } } } } } } } }, "/api/employees/{employee}/attachments/{attachment}": { "delete": { "tags": [ "Organization" ], "operationId": "employeeAttachmentControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "attachment_uuid": { "type": "string" }, "deleted": { "type": "boolean" } } } } }, "example": { "success": true, "message": "Attachment deleted successfully", "data": { "attachment_uuid": "5ec5f6a9-97e7-4b7f-9ec4-c8d2d0e0f27a", "deleted": true } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.attachments.destroy", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeAttachmentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.attachments.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.attachments.delete" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Organization" ], "operationId": "employeeAttachmentControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "employee": { "type": "object", "properties": { "id": { "type": "integer" }, "employee_code": { "type": "string" }, "name": { "type": "string" } } }, "attachment": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "purpose": { "type": "string" }, "category": { "type": "string" }, "original_name": { "type": "string" }, "status": { "type": "string" } } } } } } }, "example": { "success": true, "data": { "employee": { "id": 33, "employee_code": "EMP-1001", "name": "John Employee" }, "attachment": { "id": 71, "uuid": "5ec5f6a9-97e7-4b7f-9ec4-c8d2d0e0f27a", "purpose": "organization", "category": "contracts", "original_name": "employee-contract.pdf", "status": "active" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.attachments.show", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeAttachmentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.attachments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.attachments.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/employees/{employee}/attachments/{attachment}/complete": { "post": { "tags": [ "Organization" ], "operationId": "employeeAttachmentControllerCompletePOST", "summary": "Complete", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "status": { "type": "string" }, "uploaded_at": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Attachment finalized successfully", "data": { "attachment": { "id": 71, "uuid": "5ec5f6a9-97e7-4b7f-9ec4-c8d2d0e0f27a", "status": "active", "uploaded_at": "2026-02-18T12:05:00Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.attachments.complete", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeAttachmentController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.attachments.upload" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.attachments.upload" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checksum": { "type": "string" }, "size_bytes": { "type": "integer" } } }, "example": { "checksum": "sha256:example_checksum_value", "size_bytes": 245760 } } } } } }, "/api/employees/{employee}/attachments/{attachment}/download": { "get": { "tags": [ "Organization" ], "operationId": "employeeAttachmentControllerDownloadGET", "summary": "Download", "responses": { "200": { "description": "Successful response", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.attachments.download", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeAttachmentController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.attachments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.attachments.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/employees/{employee}/hierarchy": { "get": { "tags": [ "Organization" ], "operationId": "employeeManagementControllerHierarchyGET", "summary": "Hierarchy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "employees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "employee_code": { "type": "string" }, "department_id": { "type": "integer" }, "position_id": { "type": "integer" }, "status": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "employees": [ { "id": 20, "user_id": 12, "employee_code": "EMP-1450", "department_id": 3, "position_id": 5, "status": "active" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "employees.hierarchy", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeManagementController@hierarchy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hamburger-menu": { "get": { "tags": [ "Shared" ], "operationId": "navigationControllerGetHamburgerMenuGET", "summary": "Get Hamburger Menu", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "menu": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "url": { "type": "string" }, "permission": { "type": "string" } } } } } } } } } } }, "example": { "success": true, "data": { "menu": [ { "id": "identity", "label": "Identity", "items": [ { "id": "users", "label": "Users", "url": "/users", "permission": "users.view" } ] } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "api.navigation.hamburger-menu", "x-action": "App\\Domains\\Shared\\Controllers\\NavigationController@getHamburgerMenu", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/health": { "get": { "tags": [ "Shared" ], "operationId": "routeGETApiHealth", "summary": "GET /api/health", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "status": { "type": "string" }, "timestamp": { "type": "string" } } } } }, "example": { "success": true, "data": { "status": "ok", "timestamp": "2026-02-18T12:00:00Z" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "Closure", "x-middleware": [ "api" ] } }, "/api/hr/attendance": { "get": { "tags": [ "Shared" ], "operationId": "attendanceControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.index", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "attendanceControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.store", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/attendance/adjustments": { "get": { "tags": [ "Shared" ], "operationId": "attendanceAdjustmentControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.adjustments.index", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceAdjustmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.adjustments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.adjustments.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "attendanceAdjustmentControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.adjustments.store", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceAdjustmentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.adjustments.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.adjustments.request" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/attendance/adjustments/{adjustment}": { "get": { "tags": [ "Shared" ], "operationId": "attendanceAdjustmentControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.adjustments.show", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceAdjustmentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.adjustments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.adjustments.view" ], "parameters": [ { "name": "adjustment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/attendance/adjustments/{adjustment}/approve": { "post": { "tags": [ "Shared" ], "operationId": "attendanceAdjustmentControllerApprovePOST", "summary": "Approve", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.adjustments.approve", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceAdjustmentController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.adjustments.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.adjustments.review" ], "parameters": [ { "name": "adjustment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/attendance/adjustments/{adjustment}/reject": { "post": { "tags": [ "Shared" ], "operationId": "attendanceAdjustmentControllerRejectPOST", "summary": "Reject", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.adjustments.reject", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceAdjustmentController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.adjustments.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.adjustments.review" ], "parameters": [ { "name": "adjustment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/attendance/connectors": { "get": { "tags": [ "Shared" ], "operationId": "attendanceConnectorControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.connectors.index", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceConnectorController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.connectors.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.connectors.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "attendanceConnectorControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.connectors.store", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceConnectorController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.connectors.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.connectors.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/attendance/connectors/{connector}": { "delete": { "tags": [ "Shared" ], "operationId": "attendanceConnectorControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.connectors.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceConnectorController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.connectors.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.connectors.manage" ], "parameters": [ { "name": "connector", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/attendance/connectors/{connector}/rotate": { "post": { "tags": [ "Shared" ], "operationId": "attendanceConnectorControllerRotatePOST", "summary": "Rotate", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.connectors.rotate", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceConnectorController@rotate", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.connectors.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.connectors.manage" ], "parameters": [ { "name": "connector", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/attendance/devices/adms": { "post": { "tags": [ "Shared" ], "operationId": "attendancePushControllerAdmsPOST", "summary": "Adms", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.devices.adms", "x-action": "App\\Domains\\Hr\\Controllers\\AttendancePushController@adms", "x-middleware": [ "api" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/attendance/employee/{employee}/daily": { "get": { "tags": [ "Shared" ], "operationId": "attendanceControllerEmployeeDailyDetailGET", "summary": "Employee Daily Detail", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.employee.daily", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@employeeDailyDetail", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/attendance/monthly-summary": { "get": { "tags": [ "Shared" ], "operationId": "attendanceControllerMonthlySummaryGET", "summary": "Monthly Summary", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.monthly-summary", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@monthlySummary", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.view" ] } }, "/api/hr/attendance/my": { "get": { "tags": [ "Shared" ], "operationId": "attendanceControllerMyGET", "summary": "My", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.my", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@my", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/hr/attendance/my/adjustments": { "get": { "tags": [ "Shared" ], "operationId": "attendanceControllerMyAdjustmentsGET", "summary": "My Adjustments", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.my.adjustments", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@myAdjustments", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/hr/attendance/my/punch": { "post": { "tags": [ "Shared" ], "operationId": "attendanceControllerSelfPunchPOST", "summary": "Self Punch", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.my.punch", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@selfPunch", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.self_punch" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.self_punch" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/attendance/push": { "post": { "tags": [ "Shared" ], "operationId": "attendancePushControllerPushPOST", "summary": "Push", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.push", "x-action": "App\\Domains\\Hr\\Controllers\\AttendancePushController@push", "x-middleware": [ "api" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/attendance/{record}": { "delete": { "tags": [ "Shared" ], "operationId": "attendanceControllerVoidDELETE", "summary": "Void", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.void", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@void", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.manage" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "attendanceControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.attendance.show", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.view" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/comp-off-requests": { "get": { "tags": [ "Shared" ], "operationId": "compOffRequestControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.comp-off-requests.index", "x-action": "App\\Domains\\Hr\\Controllers\\CompOffRequestController@index", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "compOffRequestControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.comp-off-requests.store", "x-action": "App\\Domains\\Hr\\Controllers\\CompOffRequestController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.comp_off.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.comp_off.request" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/comp-off-requests/{request}/approve": { "post": { "tags": [ "Shared" ], "operationId": "compOffRequestControllerApprovePOST", "summary": "Approve", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.comp-off-requests.approve", "x-action": "App\\Domains\\Hr\\Controllers\\CompOffRequestController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.comp_off.approve" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.comp_off.approve" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/comp-off-requests/{request}/reject": { "post": { "tags": [ "Shared" ], "operationId": "compOffRequestControllerRejectPOST", "summary": "Reject", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.comp-off-requests.reject", "x-action": "App\\Domains\\Hr\\Controllers\\CompOffRequestController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.comp_off.approve" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.comp_off.approve" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/document-types": { "get": { "tags": [ "Shared" ], "operationId": "hrDocumentTypeControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.document-types.index", "x-action": "App\\Domains\\Hr\\Controllers\\HrDocumentTypeController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.document_types.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.document_types.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "hrDocumentTypeControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.document-types.store", "x-action": "App\\Domains\\Hr\\Controllers\\HrDocumentTypeController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.document_types.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.document_types.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/document-types/{type}": { "patch": { "tags": [ "Shared" ], "operationId": "hrDocumentTypeControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.document-types.update", "x-action": "App\\Domains\\Hr\\Controllers\\HrDocumentTypeController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.document_types.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.document_types.manage" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances": { "get": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.index", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company|hr.employee_account.approve|hr.employee_account.finalize|hr.employee_account.manage|hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve", "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.raise", "hr.employee_account.view.company", "hr.employee_account.view.self" ] }, "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.store", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}": { "get": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.show", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company|hr.employee_account.approve|hr.employee_account.finalize|hr.employee_account.manage|hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve", "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.raise", "hr.employee_account.view.company", "hr.employee_account.view.self" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.update", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/approve": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerApprovePOST", "summary": "Approve", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.approve", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.approve" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerCancelPOST", "summary": "Cancel", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.cancel", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise|hr.employee_account.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.manage", "hr.employee_account.raise" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/documents": { "get": { "tags": [ "Shared" ], "operationId": "employeeAdvanceDocumentControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.documents.index", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceDocumentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.view.company", "hr.employee_account.view.self" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employee-accounts/advances/{advance}/documents/intent": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceDocumentControllerCreateIntentPOST", "summary": "Create Intent", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.documents.intent", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceDocumentController@createIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/documents/upload": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceDocumentControllerUploadPOST", "summary": "Upload", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.documents.upload", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceDocumentController@upload", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/documents/{document}": { "delete": { "tags": [ "Shared" ], "operationId": "employeeAdvanceDocumentControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.documents.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceDocumentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise|hr.employee_account.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.manage", "hr.employee_account.raise" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employee-accounts/advances/{advance}/documents/{document}/download": { "get": { "tags": [ "Shared" ], "operationId": "employeeAdvanceDocumentControllerDownloadGET", "summary": "Download", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.documents.download", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceDocumentController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.view.company", "hr.employee_account.view.self" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employee-accounts/advances/{advance}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerFinalizePOST", "summary": "Finalize", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.finalize", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@finalize", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/installments": { "get": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerInstallmentsGET", "summary": "Installments", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.installments", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@installments", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company|hr.employee_account.approve|hr.employee_account.finalize|hr.employee_account.manage|hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve", "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.raise", "hr.employee_account.view.company", "hr.employee_account.view.self" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerAddInstallmentPOST", "summary": "Add Installment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.installments.add", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@addInstallment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.finalize|hr.employee_account.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/installments/{installment}": { "patch": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerUpdateInstallmentPATCH", "summary": "Update Installment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.installments.update", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@updateInstallment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.finalize|hr.employee_account.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "installment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/installments/{installment}/defer": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerDeferInstallmentPOST", "summary": "Defer Installment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.installments.defer", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@deferInstallment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.finalize|hr.employee_account.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "installment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/reject": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerRejectPOST", "summary": "Reject", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.reject", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.approve" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/reschedule": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerReschedulePOST", "summary": "Reschedule", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.reschedule", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@reschedule", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.finalize|hr.employee_account.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/advances/{advance}/statement": { "get": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerStatementGET", "summary": "Statement", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.statement", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@statement", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company|hr.employee_account.manage|hr.employee_account.finalize|hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.raise", "hr.employee_account.view.company", "hr.employee_account.view.self" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employee-accounts/advances/{advance}/submit": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerSubmitPOST", "summary": "Submit", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.advances.submit", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@submit", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "parameters": [ { "name": "advance", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims": { "get": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.index", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company|hr.employee_account.approve|hr.employee_account.finalize|hr.employee_account.manage|hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve", "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.raise", "hr.employee_account.view.company", "hr.employee_account.view.self" ] }, "post": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.store", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims/{claim}": { "get": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.show", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company|hr.employee_account.approve|hr.employee_account.finalize|hr.employee_account.manage|hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve", "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.raise", "hr.employee_account.view.company", "hr.employee_account.view.self" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.update", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims/{claim}/approve": { "post": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerApprovePOST", "summary": "Approve", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.approve", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.approve" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims/{claim}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerCancelPOST", "summary": "Cancel", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.cancel", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise|hr.employee_account.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.manage", "hr.employee_account.raise" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims/{claim}/documents": { "get": { "tags": [ "Shared" ], "operationId": "employeeClaimDocumentControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.documents.index", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimDocumentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.view.company", "hr.employee_account.view.self" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employee-accounts/claims/{claim}/documents/intent": { "post": { "tags": [ "Shared" ], "operationId": "employeeClaimDocumentControllerCreateIntentPOST", "summary": "Create Intent", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.documents.intent", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimDocumentController@createIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims/{claim}/documents/upload": { "post": { "tags": [ "Shared" ], "operationId": "employeeClaimDocumentControllerUploadPOST", "summary": "Upload", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.documents.upload", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimDocumentController@upload", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims/{claim}/documents/{document}": { "delete": { "tags": [ "Shared" ], "operationId": "employeeClaimDocumentControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.documents.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimDocumentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise|hr.employee_account.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.manage", "hr.employee_account.raise" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employee-accounts/claims/{claim}/documents/{document}/download": { "get": { "tags": [ "Shared" ], "operationId": "employeeClaimDocumentControllerDownloadGET", "summary": "Download", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.documents.download", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimDocumentController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.view.company", "hr.employee_account.view.self" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employee-accounts/claims/{claim}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerFinalizePOST", "summary": "Finalize", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.finalize", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@finalize", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims/{claim}/reject": { "post": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerRejectPOST", "summary": "Reject", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.reject", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.approve" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims/{claim}/submit": { "post": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerSubmitPOST", "summary": "Submit", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.submit", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@submit", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.raise" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/claims/{claim}/voucher-pdf": { "get": { "tags": [ "Shared" ], "operationId": "employeeClaimControllerVoucherPdfGET", "summary": "Voucher Pdf", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.claims.voucher-pdf", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeClaimController@voucherPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company|hr.employee_account.raise|hr.employee_account.approve|hr.employee_account.finalize|hr.employee_account.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.approve", "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.raise", "hr.employee_account.view.company", "hr.employee_account.view.self" ], "parameters": [ { "name": "claim", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employee-accounts/ledger": { "get": { "tags": [ "Shared" ], "operationId": "employeeLedgerControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.ledger.index", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeLedgerController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company|hr.employee_account.manage|hr.employee_account.finalize|hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.raise", "hr.employee_account.view.company", "hr.employee_account.view.self" ] } }, "/api/hr/employee-accounts/ledger/disbursement": { "post": { "tags": [ "Shared" ], "operationId": "employeeLedgerControllerDisbursementPOST", "summary": "Disbursement", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.ledger.disbursement", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeLedgerController@disbursement", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.manage|hr.employee_account.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/ledger/export-pdf": { "get": { "tags": [ "Shared" ], "operationId": "employeeLedgerControllerExportPdfGET", "summary": "Export Pdf", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.ledger.export-pdf", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeLedgerController@exportPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.self|hr.employee_account.view.company|hr.employee_account.manage|hr.employee_account.finalize|hr.employee_account.raise" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.raise", "hr.employee_account.view.company", "hr.employee_account.view.self" ] } }, "/api/hr/employee-accounts/ledger/repayment": { "post": { "tags": [ "Shared" ], "operationId": "employeeLedgerControllerRepaymentPOST", "summary": "Repayment", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.ledger.repayment", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeLedgerController@repayment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.manage|hr.employee_account.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employee-accounts/ledger/summary": { "get": { "tags": [ "Shared" ], "operationId": "employeeLedgerControllerSummaryGET", "summary": "Summary", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employee-accounts.ledger.summary", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeLedgerController@summary", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employee_account.view.company|hr.employee_account.manage|hr.employee_account.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employee_account.finalize", "hr.employee_account.manage", "hr.employee_account.view.company" ] } }, "/api/hr/employees/{employee}/contracts": { "get": { "tags": [ "Shared" ], "operationId": "hrEmployeeContractControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.contracts.index", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeContractController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.contracts.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.contracts.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "hrEmployeeContractControllerStorePOST", "summary": "Store", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.contracts.store", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeContractController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.contracts.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.contracts.create" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/contracts/{contract}": { "delete": { "tags": [ "Shared" ], "operationId": "hrEmployeeContractControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.contracts.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeContractController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.contracts.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.contracts.delete" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "hrEmployeeContractControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.contracts.show", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeContractController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.contracts.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.contracts.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrEmployeeContractControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.contracts.update", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeContractController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.contracts.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.contracts.edit" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/contracts/{contract}/attachments/intents": { "post": { "tags": [ "Shared" ], "operationId": "hrEmployeeContractControllerCreateUploadIntentPOST", "summary": "Create Upload Intent", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.contracts.attachments.intents", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeContractController@createUploadIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.contracts.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.contracts.create" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/contracts/{contract}/attachments/upload": { "post": { "tags": [ "Shared" ], "operationId": "hrEmployeeContractControllerUploadAttachmentPOST", "summary": "Upload Attachment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.contracts.attachments.upload", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeContractController@uploadAttachment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.contracts.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.contracts.create" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/contracts/{contract}/attachments/{attachment}": { "delete": { "tags": [ "Shared" ], "operationId": "hrEmployeeContractControllerDeleteAttachmentDELETE", "summary": "Delete Attachment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.contracts.attachments.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeContractController@deleteAttachment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.contracts.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.contracts.delete" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employees/{employee}/contracts/{contract}/attachments/{attachment}/download": { "get": { "tags": [ "Shared" ], "operationId": "hrEmployeeContractControllerDownloadAttachmentGET", "summary": "Download Attachment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.contracts.attachments.download", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeContractController@downloadAttachment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.contracts.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.contracts.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employees/{employee}/documents": { "get": { "tags": [ "Shared" ], "operationId": "hrEmployeeDocumentControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.documents.index", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeDocumentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.documents.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.documents.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "hrEmployeeDocumentControllerStorePOST", "summary": "Store", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.documents.store", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeDocumentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.documents.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.documents.create" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/documents/{document}": { "delete": { "tags": [ "Shared" ], "operationId": "hrEmployeeDocumentControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.documents.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeDocumentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.documents.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.documents.delete" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "hrEmployeeDocumentControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.documents.show", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeDocumentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.documents.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.documents.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrEmployeeDocumentControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.documents.update", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeDocumentController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.documents.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.documents.edit" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/documents/{document}/attachments/intents": { "post": { "tags": [ "Shared" ], "operationId": "hrEmployeeDocumentControllerCreateUploadIntentPOST", "summary": "Create Upload Intent", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.documents.attachments.intents", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeDocumentController@createUploadIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.documents.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.documents.create" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/documents/{document}/attachments/upload": { "post": { "tags": [ "Shared" ], "operationId": "hrEmployeeDocumentControllerUploadAttachmentPOST", "summary": "Upload Attachment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.documents.attachments.upload", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeDocumentController@uploadAttachment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.documents.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.documents.create" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/documents/{document}/attachments/{attachment}": { "delete": { "tags": [ "Shared" ], "operationId": "hrEmployeeDocumentControllerDeleteAttachmentDELETE", "summary": "Delete Attachment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.documents.attachments.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeDocumentController@deleteAttachment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.documents.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.documents.delete" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employees/{employee}/documents/{document}/attachments/{attachment}/download": { "get": { "tags": [ "Shared" ], "operationId": "hrEmployeeDocumentControllerDownloadAttachmentGET", "summary": "Download Attachment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.documents.attachments.download", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeDocumentController@downloadAttachment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.documents.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.documents.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/employees/{employee}/emergency-contacts": { "get": { "tags": [ "Shared" ], "operationId": "hrEmergencyContactControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.emergency-contacts.index", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmergencyContactController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.emergency_contacts.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.emergency_contacts.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "hrEmergencyContactControllerStorePOST", "summary": "Store", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.emergency-contacts.store", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmergencyContactController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.emergency_contacts.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.emergency_contacts.edit" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/emergency-contacts/{contact}": { "delete": { "tags": [ "Shared" ], "operationId": "hrEmergencyContactControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.emergency-contacts.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmergencyContactController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.emergency_contacts.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.emergency_contacts.edit" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrEmergencyContactControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.emergency-contacts.update", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmergencyContactController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.emergency_contacts.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.emergency_contacts.edit" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/profile": { "get": { "tags": [ "Shared" ], "operationId": "hrEmployeeProfileControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.profile.show", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeProfileController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employees.profile.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employees.profile.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrEmployeeProfileControllerUpdateProfilePATCH", "summary": "Update Profile", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.profile.update", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeProfileController@updateProfile", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employees.profile.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employees.profile.edit" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/employees/{employee}/profile/{section}": { "patch": { "tags": [ "Shared" ], "operationId": "hrEmployeeProfileControllerUpdateProfileSectionPATCH", "summary": "Update Profile Section", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.employees.profile.section.update", "x-action": "App\\Domains\\Hr\\Controllers\\HrEmployeeProfileController@updateProfileSection", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.employees.profile.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.employees.profile.edit" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "section", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/assigned": { "get": { "tags": [ "Shared" ], "operationId": "hrFormGeneralControllerAssignedGET", "summary": "Assigned", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.assigned.index", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormGeneralController@assigned", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.create.self|hr.forms.submissions.view.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.create.self", "hr.forms.submissions.view.self" ] } }, "/api/hr/forms/assignments": { "get": { "tags": [ "Shared" ], "operationId": "hrFormAssignmentControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.assignments.index", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAssignmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.assignments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.assignments.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "hrFormAssignmentControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.assignments.store", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAssignmentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.assignments.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.assignments.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/assignments/{assignment}": { "get": { "tags": [ "Shared" ], "operationId": "hrFormAssignmentControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.assignments.show", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAssignmentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.assignments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.assignments.view" ], "parameters": [ { "name": "assignment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/forms/assignments/{assignment}/revoke": { "post": { "tags": [ "Shared" ], "operationId": "hrFormAssignmentControllerRevokePOST", "summary": "Revoke", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.assignments.revoke", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAssignmentController@revoke", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.assignments.revoke" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.assignments.revoke" ], "parameters": [ { "name": "assignment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/assignments/{assignment}/send": { "post": { "tags": [ "Shared" ], "operationId": "hrFormAssignmentControllerSendPOST", "summary": "Send", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.assignments.send", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAssignmentController@send", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.assignments.send" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.assignments.send" ], "parameters": [ { "name": "assignment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/blocks/{block}": { "delete": { "tags": [ "Shared" ], "operationId": "hrFormBlockControllerDeleteBlockDELETE", "summary": "Delete Block", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.blocks.delete", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormBlockController@deleteBlock", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "block", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrFormBlockControllerUpdateBlockPATCH", "summary": "Update Block", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.blocks.update", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormBlockController@updateBlock", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "block", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/blocks/{block}/fields": { "post": { "tags": [ "Shared" ], "operationId": "hrFormBlockControllerStoreFieldPOST", "summary": "Store Field", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.blocks.fields.store", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormBlockController@storeField", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "block", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/blocks/{block}/fields/reorder": { "post": { "tags": [ "Shared" ], "operationId": "hrFormBlockControllerReorderFieldsPOST", "summary": "Reorder Fields", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.blocks.fields.reorder", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormBlockController@reorderFields", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "block", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/exports": { "get": { "tags": [ "Shared" ], "operationId": "hrFormExportControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.exports.index", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormExportController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.exports.view.self|hr.forms.exports.view.team|hr.forms.exports.view.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.exports.view.company", "hr.forms.exports.view.self", "hr.forms.exports.view.team" ] }, "post": { "tags": [ "Shared" ], "operationId": "hrFormExportControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.exports.store", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormExportController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.export" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/exports/{export}/download": { "get": { "tags": [ "Shared" ], "operationId": "hrFormExportControllerDownloadGET", "summary": "Download", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.exports.download", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormExportController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.exports.view.self|hr.forms.exports.view.team|hr.forms.exports.view.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.exports.view.company", "hr.forms.exports.view.self", "hr.forms.exports.view.team" ], "parameters": [ { "name": "export", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/forms/field-definitions": { "get": { "tags": [ "Shared" ], "operationId": "routeGETApiHrFormsFieldDefinitions", "summary": "GET /api/hr/forms/field-definitions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.field-definitions", "x-action": "Closure", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.view|hr.forms.templates.manage|hr.forms.submissions.create.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.create.self", "hr.forms.templates.manage", "hr.forms.templates.view" ] } }, "/api/hr/forms/fields/{field}": { "delete": { "tags": [ "Shared" ], "operationId": "hrFormBlockControllerDeleteFieldDELETE", "summary": "Delete Field", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.fields.delete", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormBlockController@deleteField", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "field", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrFormBlockControllerUpdateFieldPATCH", "summary": "Update Field", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.fields.update", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormBlockController@updateField", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "field", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/general": { "get": { "tags": [ "Shared" ], "operationId": "hrFormGeneralControllerCatalogGET", "summary": "Catalog", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.general.index", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormGeneralController@catalog", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.create.self|hr.forms.submissions.view.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.create.self", "hr.forms.submissions.view.self" ] } }, "/api/hr/forms/reviews": { "get": { "tags": [ "Shared" ], "operationId": "hrFormReviewControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.reviews.index", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormReviewController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.review" ] } }, "/api/hr/forms/reviews/{review}/approve": { "post": { "tags": [ "Shared" ], "operationId": "hrFormReviewControllerApprovePOST", "summary": "Approve", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.reviews.approve", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormReviewController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.approve" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.approve" ], "parameters": [ { "name": "review", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/reviews/{review}/reject": { "post": { "tags": [ "Shared" ], "operationId": "hrFormReviewControllerRejectPOST", "summary": "Reject", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.reviews.reject", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormReviewController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.reject" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.reject" ], "parameters": [ { "name": "review", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/reviews/{review}/return": { "post": { "tags": [ "Shared" ], "operationId": "hrFormReviewControllerReturnPOST", "summary": "Return", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.reviews.return", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormReviewController@return", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.return" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.return" ], "parameters": [ { "name": "review", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/submissions": { "get": { "tags": [ "Shared" ], "operationId": "hrFormSubmissionControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.index", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormSubmissionController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.view.self|hr.forms.submissions.view.team|hr.forms.submissions.view.company|hr.forms.submissions.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.review", "hr.forms.submissions.view.company", "hr.forms.submissions.view.self", "hr.forms.submissions.view.team" ] }, "post": { "tags": [ "Shared" ], "operationId": "hrFormSubmissionControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.store", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormSubmissionController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.create.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.create.self" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/submissions/{submission}": { "get": { "tags": [ "Shared" ], "operationId": "hrFormSubmissionControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.show", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormSubmissionController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.view.self|hr.forms.submissions.view.team|hr.forms.submissions.view.company|hr.forms.submissions.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.review", "hr.forms.submissions.view.company", "hr.forms.submissions.view.self", "hr.forms.submissions.view.team" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/forms/submissions/{submission}/approve-reopen": { "post": { "tags": [ "Shared" ], "operationId": "hrFormSubmissionControllerApproveReopenPOST", "summary": "Approve Reopen", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.approve-reopen", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormSubmissionController@approveReopen", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.reopen.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.reopen.manage" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/submissions/{submission}/attachments": { "get": { "tags": [ "Shared" ], "operationId": "hrFormAttachmentControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.attachments.index", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAttachmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.view.self|hr.forms.submissions.view.team|hr.forms.submissions.view.company|hr.forms.submissions.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.review", "hr.forms.submissions.view.company", "hr.forms.submissions.view.self", "hr.forms.submissions.view.team" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/forms/submissions/{submission}/attachments/intents": { "post": { "tags": [ "Shared" ], "operationId": "hrFormAttachmentControllerCreateIntentPOST", "summary": "Create Intent", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.attachments.intents", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAttachmentController@createIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.edit.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.edit.self" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/submissions/{submission}/attachments/upload": { "post": { "tags": [ "Shared" ], "operationId": "hrFormAttachmentControllerUploadPOST", "summary": "Upload", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.attachments.upload", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAttachmentController@upload", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.edit.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.edit.self" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/submissions/{submission}/attachments/{attachment}": { "delete": { "tags": [ "Shared" ], "operationId": "hrFormAttachmentControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.attachments.delete", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAttachmentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.edit.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.edit.self" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/forms/submissions/{submission}/attachments/{attachment}/download": { "get": { "tags": [ "Shared" ], "operationId": "hrFormAttachmentControllerDownloadGET", "summary": "Download", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.attachments.download", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormAttachmentController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.view.self|hr.forms.submissions.view.team|hr.forms.submissions.view.company|hr.forms.submissions.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.review", "hr.forms.submissions.view.company", "hr.forms.submissions.view.self", "hr.forms.submissions.view.team" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/forms/submissions/{submission}/draft": { "patch": { "tags": [ "Shared" ], "operationId": "hrFormSubmissionControllerSaveDraftPATCH", "summary": "Save Draft", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.draft", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormSubmissionController@saveDraft", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.edit.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.edit.self" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/submissions/{submission}/reject-reopen": { "post": { "tags": [ "Shared" ], "operationId": "hrFormSubmissionControllerRejectReopenPOST", "summary": "Reject Reopen", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.reject-reopen", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormSubmissionController@rejectReopen", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.reopen.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.reopen.manage" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/submissions/{submission}/request-reopen": { "post": { "tags": [ "Shared" ], "operationId": "hrFormSubmissionControllerRequestReopenPOST", "summary": "Request Reopen", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.request-reopen", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormSubmissionController@requestReopen", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.view.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.view.self" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/submissions/{submission}/submit": { "post": { "tags": [ "Shared" ], "operationId": "hrFormSubmissionControllerSubmitPOST", "summary": "Submit", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.submit", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormSubmissionController@submit", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.submit.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.submit.self" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/submissions/{submission}/withdraw": { "post": { "tags": [ "Shared" ], "operationId": "hrFormSubmissionControllerWithdrawPOST", "summary": "Withdraw", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.submissions.withdraw", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormSubmissionController@withdraw", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.submissions.edit.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.edit.self" ], "parameters": [ { "name": "submission", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/templates": { "get": { "tags": [ "Shared" ], "operationId": "hrFormTemplateControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.templates.index", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormTemplateController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "hrFormTemplateControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.templates.store", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormTemplateController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/templates/{template}": { "get": { "tags": [ "Shared" ], "operationId": "hrFormTemplateControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.templates.show", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormTemplateController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.view" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrFormTemplateControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.templates.update", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormTemplateController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/templates/{template}/archive": { "post": { "tags": [ "Shared" ], "operationId": "hrFormTemplateControllerArchivePOST", "summary": "Archive", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.templates.archive", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormTemplateController@archive", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.archive" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.archive" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/templates/{template}/versions": { "post": { "tags": [ "Shared" ], "operationId": "hrFormTemplateVersionControllerStorePOST", "summary": "Store", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.templates.versions.store", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormTemplateVersionController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/versions/{version}": { "get": { "tags": [ "Shared" ], "operationId": "hrFormTemplateVersionControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.versions.show", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormTemplateVersionController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.view|hr.forms.submissions.create.self|hr.forms.submissions.view.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.submissions.create.self", "hr.forms.submissions.view.self", "hr.forms.templates.view" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrFormTemplateVersionControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.versions.update", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormTemplateVersionController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/versions/{version}/blocks": { "post": { "tags": [ "Shared" ], "operationId": "hrFormBlockControllerStoreBlockPOST", "summary": "Store Block", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.versions.blocks.store", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormBlockController@storeBlock", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/versions/{version}/blocks/reorder": { "post": { "tags": [ "Shared" ], "operationId": "hrFormBlockControllerReorderBlocksPOST", "summary": "Reorder Blocks", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.versions.blocks.reorder", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormBlockController@reorderBlocks", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.manage" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/forms/versions/{version}/publish": { "post": { "tags": [ "Shared" ], "operationId": "hrFormTemplateVersionControllerPublishPOST", "summary": "Publish", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.forms.versions.publish", "x-action": "App\\Domains\\Hr\\Forms\\Controllers\\HrFormTemplateVersionController@publish", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.forms.templates.publish" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.forms.templates.publish" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/holidays": { "get": { "tags": [ "Shared" ], "operationId": "holidayControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.holidays.index", "x-action": "App\\Domains\\Hr\\Controllers\\HolidayController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.holidays.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.holidays.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "holidayControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.holidays.store", "x-action": "App\\Domains\\Hr\\Controllers\\HolidayController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.holidays.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.holidays.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/holidays/{holiday}": { "delete": { "tags": [ "Shared" ], "operationId": "holidayControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.holidays.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HolidayController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.holidays.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.holidays.manage" ], "parameters": [ { "name": "holiday", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "holidayControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.holidays.update", "x-action": "App\\Domains\\Hr\\Controllers\\HolidayController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.holidays.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.holidays.manage" ], "parameters": [ { "name": "holiday", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/adjustments": { "post": { "tags": [ "Shared" ], "operationId": "leaveAdjustmentControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.adjustments.store", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveAdjustmentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.balance.adjust" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.balance.adjust" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/balances": { "get": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerAllBalancesGET", "summary": "All Balances", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.balances.index", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@allBalances", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.ledger.view.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.ledger.view.company" ] } }, "/api/hr/leaves/balances/me": { "get": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerMyBalancesGET", "summary": "My Balances", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.balances.me", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@myBalances", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.view.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.view.self" ] } }, "/api/hr/leaves/balances/{employee}": { "get": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerEmployeeBalancesGET", "summary": "Employee Balances", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.balances.employee", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@employeeBalances", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.view.team" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.view.team" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/leaves/calendar": { "get": { "tags": [ "Shared" ], "operationId": "leaveCalendarControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.calendar.index", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveCalendarController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.view.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.view.self" ] } }, "/api/hr/leaves/calendar/team-availability": { "get": { "tags": [ "Shared" ], "operationId": "leaveCalendarControllerTeamAvailabilityGET", "summary": "Team Availability", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.calendar.team-availability", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveCalendarController@teamAvailability", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.view.team" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.view.team" ] } }, "/api/hr/leaves/ledger/{employee}": { "get": { "tags": [ "Shared" ], "operationId": "leaveAdjustmentControllerLedgerGET", "summary": "Ledger", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.ledger.employee", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveAdjustmentController@ledger", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.ledger.view.self|hr.leave.ledger.view.team|hr.leave.ledger.view.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.ledger.view.company", "hr.leave.ledger.view.self", "hr.leave.ledger.view.team" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/leaves/requests": { "get": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.index", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.view.self|hr.leave.view.team|hr.leave.approve.team|hr.leave.finalize|hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.approve.team", "hr.leave.finalize", "hr.leave.request", "hr.leave.view.self", "hr.leave.view.team" ] }, "post": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.store", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.request" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/requests/pending-approvals": { "get": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerPendingApprovalsGET", "summary": "Pending Approvals", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.pending-approvals", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@pendingApprovals", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.approve.team|hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.approve.team", "hr.leave.request" ] } }, "/api/hr/leaves/requests/{leaveRequest}/documents": { "get": { "tags": [ "Shared" ], "operationId": "leaveDocumentControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.documents.index", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveDocumentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.view.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.view.self" ], "parameters": [ { "name": "leaveRequest", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/leaves/requests/{leaveRequest}/documents/intent": { "post": { "tags": [ "Shared" ], "operationId": "leaveDocumentControllerCreateIntentPOST", "summary": "Create Intent", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.documents.intent", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveDocumentController@createIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.request" ], "parameters": [ { "name": "leaveRequest", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/requests/{leaveRequest}/documents/upload": { "post": { "tags": [ "Shared" ], "operationId": "leaveDocumentControllerUploadPOST", "summary": "Upload", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.documents.upload", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveDocumentController@upload", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.request" ], "parameters": [ { "name": "leaveRequest", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/requests/{leaveRequest}/documents/{document}": { "delete": { "tags": [ "Shared" ], "operationId": "leaveDocumentControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.documents.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveDocumentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.request" ], "parameters": [ { "name": "leaveRequest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/leaves/requests/{leaveRequest}/documents/{document}/download": { "get": { "tags": [ "Shared" ], "operationId": "leaveDocumentControllerDownloadGET", "summary": "Download", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.documents.download", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveDocumentController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.view.self" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.view.self" ], "parameters": [ { "name": "leaveRequest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/leaves/requests/{request}": { "get": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.show", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.view.self|hr.leave.view.team|hr.leave.approve.team|hr.leave.finalize|hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.approve.team", "hr.leave.finalize", "hr.leave.request", "hr.leave.view.self", "hr.leave.view.team" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.update", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.request" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/requests/{request}/approve": { "post": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerApproveStepPOST", "summary": "Approve Step", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.approve", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@approveStep", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.approve.team|hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.approve.team", "hr.leave.request" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/requests/{request}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerCancelPOST", "summary": "Cancel", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.cancel", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.request" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/requests/{request}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerFinalizePOST", "summary": "Finalize", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.finalize", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@finalize", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.finalize" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/requests/{request}/reject": { "post": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerRejectStepPOST", "summary": "Reject Step", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.reject", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@rejectStep", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.approve.team|hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.approve.team", "hr.leave.request" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/requests/{request}/return": { "post": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerReturnForUpdatePOST", "summary": "Return For Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.return", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@returnForUpdate", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.approve.team|hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.approve.team", "hr.leave.request" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/requests/{request}/submit": { "post": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerSubmitPOST", "summary": "Submit", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.requests.submit", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@submit", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.request" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/rules": { "get": { "tags": [ "Shared" ], "operationId": "hrRuleControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.index", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "hrRuleControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.store", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/rules/effective/{employee}": { "get": { "tags": [ "Shared" ], "operationId": "hrRuleControllerEffectiveRulesGET", "summary": "Effective Rules", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.effective", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@effectiveRules", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/leaves/rules/field-definitions": { "get": { "tags": [ "Shared" ], "operationId": "hrRuleControllerFieldDefinitionsGET", "summary": "Field Definitions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.field-definitions", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@fieldDefinitions", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.view" ] } }, "/api/hr/leaves/rules/{rule}": { "delete": { "tags": [ "Shared" ], "operationId": "hrRuleControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.manage" ], "parameters": [ { "name": "rule", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "hrRuleControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.show", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.view" ], "parameters": [ { "name": "rule", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrRuleControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.update", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.manage" ], "parameters": [ { "name": "rule", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/rules/{rule}/assignments": { "get": { "tags": [ "Shared" ], "operationId": "hrRuleControllerAssignmentsGET", "summary": "Assignments", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.assignments.index", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@assignments", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.view" ], "parameters": [ { "name": "rule", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "hrRuleControllerAssignPOST", "summary": "Assign", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.assignments.store", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@assign", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.assign" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.assign" ], "parameters": [ { "name": "rule", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/rules/{rule}/assignments/{assignment}": { "delete": { "tags": [ "Shared" ], "operationId": "hrRuleControllerRemoveAssignmentDELETE", "summary": "Remove Assignment", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.rules.assignments.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HrRuleController@removeAssignment", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.rules.assign" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.rules.assign" ], "parameters": [ { "name": "rule", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assignment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/leaves/settings": { "get": { "tags": [ "Shared" ], "operationId": "leaveSettingsControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.settings.show", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveSettingsController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.settings.view" ] }, "patch": { "tags": [ "Shared" ], "operationId": "leaveSettingsControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.settings.update", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveSettingsController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.settings.manage" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/attendance-requests": { "get": { "tags": [ "Shared" ], "operationId": "timeBackControllerAttendanceRequestsGET", "summary": "Attendance Requests", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.attendance.index", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@attendanceRequests", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.attendance_adjust|hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.attendance_adjust", "hr.leave.time_back.review" ] }, "post": { "tags": [ "Shared" ], "operationId": "timeBackControllerStoreAttendanceRequestPOST", "summary": "Store Attendance Request", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.attendance.store", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@storeAttendanceRequest", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.attendance_adjust" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.attendance_adjust" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/attendance-requests/{usageRequest}/approve": { "post": { "tags": [ "Shared" ], "operationId": "timeBackControllerApproveAttendanceRequestPOST", "summary": "Approve Attendance Request", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.attendance.approve", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@approveAttendanceRequest", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.review" ], "parameters": [ { "name": "usageRequest", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/attendance-requests/{usageRequest}/reject": { "post": { "tags": [ "Shared" ], "operationId": "timeBackControllerRejectAttendanceRequestPOST", "summary": "Reject Attendance Request", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.attendance.reject", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@rejectAttendanceRequest", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.review" ], "parameters": [ { "name": "usageRequest", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/balance": { "get": { "tags": [ "Shared" ], "operationId": "timeBackControllerBalanceGET", "summary": "Balance", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.balance", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@balance", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.request|hr.leave.time_back.convert|hr.leave.time_back.attendance_adjust|hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.attendance_adjust", "hr.leave.time_back.convert", "hr.leave.time_back.request", "hr.leave.time_back.review" ] } }, "/api/hr/leaves/time-back/conversions": { "get": { "tags": [ "Shared" ], "operationId": "timeBackControllerConversionsGET", "summary": "Conversions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.conversions.index", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@conversions", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.convert|hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.convert", "hr.leave.time_back.review" ] }, "post": { "tags": [ "Shared" ], "operationId": "timeBackControllerStoreConversionPOST", "summary": "Store Conversion", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.conversions.store", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@storeConversion", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.convert" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.convert" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/conversions/{conversion}/approve": { "post": { "tags": [ "Shared" ], "operationId": "timeBackControllerApproveConversionPOST", "summary": "Approve Conversion", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.conversions.approve", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@approveConversion", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.review" ], "parameters": [ { "name": "conversion", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/conversions/{conversion}/reject": { "post": { "tags": [ "Shared" ], "operationId": "timeBackControllerRejectConversionPOST", "summary": "Reject Conversion", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.conversions.reject", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@rejectConversion", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.review" ], "parameters": [ { "name": "conversion", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/grants": { "get": { "tags": [ "Shared" ], "operationId": "timeBackControllerGrantsGET", "summary": "Grants", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.grants.index", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@grants", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.request|hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.request", "hr.leave.time_back.review" ] }, "post": { "tags": [ "Shared" ], "operationId": "timeBackControllerStoreGrantPOST", "summary": "Store Grant", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.grants.store", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@storeGrant", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.request" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.request" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/grants/{grant}/approve": { "post": { "tags": [ "Shared" ], "operationId": "timeBackControllerApproveGrantPOST", "summary": "Approve Grant", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.grants.approve", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@approveGrant", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.review" ], "parameters": [ { "name": "grant", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/grants/{grant}/reject": { "post": { "tags": [ "Shared" ], "operationId": "timeBackControllerRejectGrantPOST", "summary": "Reject Grant", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.grants.reject", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@rejectGrant", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.review" ], "parameters": [ { "name": "grant", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/time-back/ledger": { "get": { "tags": [ "Shared" ], "operationId": "timeBackControllerLedgerGET", "summary": "Ledger", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.time-back.ledger", "x-action": "App\\Domains\\Hr\\Controllers\\TimeBackController@ledger", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.time_back.request|hr.leave.time_back.convert|hr.leave.time_back.attendance_adjust|hr.leave.time_back.review" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.time_back.attendance_adjust", "hr.leave.time_back.convert", "hr.leave.time_back.request", "hr.leave.time_back.review" ] } }, "/api/hr/leaves/types": { "get": { "tags": [ "Shared" ], "operationId": "leaveTypeControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.types.index", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveTypeController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.types.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.types.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "leaveTypeControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.types.store", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveTypeController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.types.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.types.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/leaves/types/{type}": { "get": { "tags": [ "Shared" ], "operationId": "leaveTypeControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.types.show", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveTypeController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.types.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.types.view" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "leaveTypeControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.leaves.types.update", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveTypeController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.leave.types.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.types.manage" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/payroll/payslips": { "get": { "tags": [ "Shared" ], "operationId": "payrollControllerPayslipsGET", "summary": "Payslips", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.payslips.index", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@payslips", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.self|hr.payroll.view.team|hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company", "hr.payroll.view.self", "hr.payroll.view.team" ] } }, "/api/hr/payroll/payslips/{payslip}": { "get": { "tags": [ "Shared" ], "operationId": "payrollControllerShowPayslipGET", "summary": "Show Payslip", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.payslips.show", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@showPayslip", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.self|hr.payroll.view.team|hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company", "hr.payroll.view.self", "hr.payroll.view.team" ], "parameters": [ { "name": "payslip", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/payroll/payslips/{payslip}/export/excel": { "get": { "tags": [ "Shared" ], "operationId": "payrollExportControllerExportPayslipExcelGET", "summary": "Export Payslip Excel", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.payslips.export.excel", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollExportController@exportPayslipExcel", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.self|hr.payroll.view.team|hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company", "hr.payroll.view.self", "hr.payroll.view.team" ], "parameters": [ { "name": "payslip", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/payroll/payslips/{payslip}/export/pdf": { "get": { "tags": [ "Shared" ], "operationId": "payrollExportControllerExportPayslipPdfGET", "summary": "Export Payslip Pdf", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.payslips.export.pdf", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollExportController@exportPayslipPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.self|hr.payroll.view.team|hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company", "hr.payroll.view.self", "hr.payroll.view.team" ], "parameters": [ { "name": "payslip", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/payroll/payslips/{payslip}/manual-adjustments": { "patch": { "tags": [ "Shared" ], "operationId": "payrollControllerUpdatePayslipManualAdjustmentsPATCH", "summary": "Update Payslip Manual Adjustments", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.payslips.manual-adjustments.update", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@updatePayslipManualAdjustments", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "payslip", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/payroll/periods": { "get": { "tags": [ "Shared" ], "operationId": "payrollControllerPeriodsGET", "summary": "Periods", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.periods.index", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@periods", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company" ] }, "post": { "tags": [ "Shared" ], "operationId": "payrollControllerCreatePeriodPOST", "summary": "Create Period", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.periods.store", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@createPeriod", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/payroll/periods/{period}": { "get": { "tags": [ "Shared" ], "operationId": "payrollControllerShowPeriodGET", "summary": "Show Period", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.periods.show", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@showPeriod", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company" ], "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/payroll/periods/{period}/compute": { "post": { "tags": [ "Shared" ], "operationId": "payrollControllerComputePeriodPOST", "summary": "Compute Period", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.periods.compute", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@computePeriod", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/payroll/periods/{period}/export/excel": { "get": { "tags": [ "Shared" ], "operationId": "payrollExportControllerExportPeriodExcelGET", "summary": "Export Period Excel", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.periods.export.excel", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollExportController@exportPeriodExcel", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company" ], "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/payroll/periods/{period}/export/pdf": { "get": { "tags": [ "Shared" ], "operationId": "payrollExportControllerExportPeriodPdfGET", "summary": "Export Period Pdf", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.periods.export.pdf", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollExportController@exportPeriodPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company" ], "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/payroll/periods/{period}/export/sif": { "get": { "tags": [ "Shared" ], "operationId": "payrollExportControllerExportPeriodSifGET", "summary": "Export Period Sif", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.periods.export.sif", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollExportController@exportPeriodSif", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company" ], "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/payroll/periods/{period}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "payrollControllerFinalizePeriodPOST", "summary": "Finalize Period", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.periods.finalize", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@finalizePeriod", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize" ], "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/payroll/sif/payers": { "get": { "tags": [ "Shared" ], "operationId": "payrollControllerListSifPayersGET", "summary": "List Sif Payers", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.sif.payers.index", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@listSifPayers", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company" ] }, "post": { "tags": [ "Shared" ], "operationId": "payrollControllerCreateSifPayerPOST", "summary": "Create Sif Payer", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.sif.payers.store", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@createSifPayer", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/payroll/sif/payers/{payer}": { "delete": { "tags": [ "Shared" ], "operationId": "payrollControllerDeleteSifPayerDELETE", "summary": "Delete Sif Payer", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.sif.payers.delete", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@deleteSifPayer", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "payer", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "payrollControllerUpdateSifPayerPATCH", "summary": "Update Sif Payer", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.sif.payers.update", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@updateSifPayer", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "payer", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/payroll/sif/profiles": { "get": { "tags": [ "Shared" ], "operationId": "payrollControllerListSifProfilesGET", "summary": "List Sif Profiles", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.sif.profiles.index", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@listSifProfiles", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.view.company|hr.payroll.manage|hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize", "hr.payroll.manage", "hr.payroll.view.company" ] } }, "/api/hr/payroll/sif/profiles/{employee}": { "put": { "tags": [ "Shared" ], "operationId": "payrollControllerUpsertSifProfilePUT", "summary": "Upsert Sif Profile", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.payroll.sif.profiles.upsert", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@upsertSifProfile", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/rota/employees/{employee}/rota": { "get": { "tags": [ "Shared" ], "operationId": "rotaControllerEmployeeRotaGET", "summary": "Employee Rota", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.employees.rota", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@employeeRota", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.view" ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/rota/weeks": { "get": { "tags": [ "Shared" ], "operationId": "rotaControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.index", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "rotaControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.store", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.manage.self_team|hr.rota.manage.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.manage.company", "hr.rota.manage.self_team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/rota/weeks/{week}": { "get": { "tags": [ "Shared" ], "operationId": "rotaControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.show", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.view" ], "parameters": [ { "name": "week", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/rota/weeks/{week}/approve": { "post": { "tags": [ "Shared" ], "operationId": "rotaControllerApprovePOST", "summary": "Approve", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.approve", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.approve.hr" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.approve.hr" ], "parameters": [ { "name": "week", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/rota/weeks/{week}/assignments": { "patch": { "tags": [ "Shared" ], "operationId": "rotaControllerUpdateAssignmentsPATCH", "summary": "Update Assignments", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.assignments.update", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@updateAssignments", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.manage.self_team|hr.rota.manage.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.manage.company", "hr.rota.manage.self_team" ], "parameters": [ { "name": "week", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/rota/weeks/{week}/copy-forward": { "post": { "tags": [ "Shared" ], "operationId": "rotaControllerCopyForwardPOST", "summary": "Copy Forward", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.copy-forward", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@copyForward", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.manage.self_team|hr.rota.manage.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.manage.company", "hr.rota.manage.self_team" ], "parameters": [ { "name": "week", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/rota/weeks/{week}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "rotaControllerFinalizePOST", "summary": "Finalize", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.finalize", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@finalize", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.finalize" ], "parameters": [ { "name": "week", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/rota/weeks/{week}/reject": { "post": { "tags": [ "Shared" ], "operationId": "rotaControllerRejectPOST", "summary": "Reject", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.reject", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.approve.hr" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.approve.hr" ], "parameters": [ { "name": "week", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/rota/weeks/{week}/reopen": { "post": { "tags": [ "Shared" ], "operationId": "rotaControllerReopenPOST", "summary": "Reopen", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.reopen", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@reopen", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.finalize" ], "parameters": [ { "name": "week", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/rota/weeks/{week}/return": { "post": { "tags": [ "Shared" ], "operationId": "rotaControllerReturnForChangesPOST", "summary": "Return For Changes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.return", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@returnForChanges", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.approve.hr" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.approve.hr" ], "parameters": [ { "name": "week", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/rota/weeks/{week}/submit": { "post": { "tags": [ "Shared" ], "operationId": "rotaControllerSubmitPOST", "summary": "Submit", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.rota.weeks.submit", "x-action": "App\\Domains\\Hr\\Controllers\\RotaController@submit", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.submit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.submit" ], "parameters": [ { "name": "week", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/salary-head-definitions": { "get": { "tags": [ "Shared" ], "operationId": "hrSalaryHeadDefinitionControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.salary-head-definitions.index", "x-action": "App\\Domains\\Hr\\Controllers\\HrSalaryHeadDefinitionController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.salary_head_definitions.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.salary_head_definitions.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "hrSalaryHeadDefinitionControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.salary-head-definitions.store", "x-action": "App\\Domains\\Hr\\Controllers\\HrSalaryHeadDefinitionController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.salary_head_definitions.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.salary_head_definitions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/salary-head-definitions/{definition}": { "delete": { "tags": [ "Shared" ], "operationId": "hrSalaryHeadDefinitionControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.salary-head-definitions.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HrSalaryHeadDefinitionController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.salary_head_definitions.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.salary_head_definitions.manage" ], "parameters": [ { "name": "definition", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrSalaryHeadDefinitionControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.salary-head-definitions.update", "x-action": "App\\Domains\\Hr\\Controllers\\HrSalaryHeadDefinitionController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.salary_head_definitions.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.salary_head_definitions.manage" ], "parameters": [ { "name": "definition", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/shift-templates": { "get": { "tags": [ "Shared" ], "operationId": "hrShiftTemplateControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.shift-templates.index", "x-action": "App\\Domains\\Hr\\Controllers\\HrShiftTemplateController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "hrShiftTemplateControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.shift-templates.store", "x-action": "App\\Domains\\Hr\\Controllers\\HrShiftTemplateController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.manage.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.manage.company" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/shift-templates/{template}": { "delete": { "tags": [ "Shared" ], "operationId": "hrShiftTemplateControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.shift-templates.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\HrShiftTemplateController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.manage.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.manage.company" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "hrShiftTemplateControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.shift-templates.update", "x-action": "App\\Domains\\Hr\\Controllers\\HrShiftTemplateController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.rota.manage.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.rota.manage.company" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/work-sites": { "get": { "tags": [ "Shared" ], "operationId": "workSiteControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.work-sites.index", "x-action": "App\\Domains\\Hr\\Controllers\\WorkSiteController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.geofence.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.geofence.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "workSiteControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.work-sites.store", "x-action": "App\\Domains\\Hr\\Controllers\\WorkSiteController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.geofence.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.geofence.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/work-sites/settings/geofence": { "get": { "tags": [ "Shared" ], "operationId": "workSiteControllerGeofenceSettingsGET", "summary": "Geofence Settings", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.work-sites.settings.geofence", "x-action": "App\\Domains\\Hr\\Controllers\\WorkSiteController@geofenceSettings", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.self_punch|hr.attendance.geofence.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.geofence.view", "hr.attendance.self_punch" ] }, "put": { "tags": [ "Shared" ], "operationId": "workSiteControllerUpdateGeofenceSettingsPUT", "summary": "Update Geofence Settings", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.work-sites.settings.geofence.update", "x-action": "App\\Domains\\Hr\\Controllers\\WorkSiteController@updateGeofenceSettings", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.geofence.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.geofence.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/hr/work-sites/{site}": { "delete": { "tags": [ "Shared" ], "operationId": "workSiteControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.work-sites.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\WorkSiteController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.geofence.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.geofence.manage" ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "workSiteControllerUpdatePUT", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "hr.work-sites.update", "x-action": "App\\Domains\\Hr\\Controllers\\WorkSiteController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:hr.attendance.geofence.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.geofence.manage" ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/menu": { "get": { "tags": [ "Shared" ], "operationId": "navigationControllerGetMenuGET", "summary": "Get Menu", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "menu": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "url": { "type": "string" }, "permission": { "type": "string" } } } } } } } } } } }, "example": { "success": true, "data": { "menu": [ { "id": "identity", "label": "Identity", "items": [ { "id": "users", "label": "Users", "url": "/users", "permission": "users.view" } ] } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "api.navigation.menu", "x-action": "App\\Domains\\Shared\\Controllers\\NavigationController@getMenu", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/navigation/companies": { "get": { "tags": [ "Shared" ], "operationId": "navigationControllerGetCompaniesGET", "summary": "Get Companies", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" } } } } } } } }, "example": { "success": true, "data": { "companies": [ { "id": 1, "name": "Acme Medical", "code": "ACME" }, { "id": 2, "name": "Beta Clinic", "code": "BETA" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "api.navigation.companies", "x-action": "App\\Domains\\Shared\\Controllers\\NavigationController@getCompanies", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/navigation/permissions": { "get": { "tags": [ "Shared" ], "operationId": "navigationControllerGetPermissionsGET", "summary": "Get Permissions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "api.navigation.permissions", "x-action": "App\\Domains\\Shared\\Controllers\\NavigationController@getPermissions", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/notification-preferences": { "get": { "tags": [ "Shared" ], "operationId": "notificationPreferenceControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notification-preferences.index", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationPreferenceController@index", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "put": { "tags": [ "Shared" ], "operationId": "notificationPreferenceControllerUpdatePUT", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notification-preferences.update", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationPreferenceController@update", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "in_app_enabled": { "type": "boolean" }, "email_enabled": { "type": "boolean" }, "push_enabled": { "type": "boolean" } } }, "example": { "in_app_enabled": true, "email_enabled": false, "push_enabled": true } } } } } }, "/api/notification-preferences/preference": { "patch": { "tags": [ "Shared" ], "operationId": "notificationPreferenceControllerUpdatePreferencePATCH", "summary": "Update Preference", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notification-preferences.update-preference", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationPreferenceController@updatePreference", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" }, "enabled": { "type": "boolean" } } }, "example": { "channel": "push", "enabled": true } } } } } }, "/api/notification-preferences/reset": { "delete": { "tags": [ "Shared" ], "operationId": "notificationPreferenceControllerResetDELETE", "summary": "Reset", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notification-preferences.reset", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationPreferenceController@reset", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/notifications": { "get": { "tags": [ "Shared" ], "operationId": "notificationControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "notifications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "message": { "type": "string" }, "read_at": { "type": "null" }, "created_at": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer" }, "total": { "type": "integer" }, "per_page": { "type": "integer" }, "last_page": { "type": "integer" } } } } } } }, "example": { "success": true, "data": { "notifications": [ { "id": 101, "title": "Approval Required", "message": "Leave request #22 needs approval", "read_at": null, "created_at": "2026-02-18T12:00:00Z" } ], "pagination": { "current_page": 1, "total": 1, "per_page": 15, "last_page": 1 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notifications.index", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationController@index", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/notifications/mark-all-as-read": { "patch": { "tags": [ "Shared" ], "operationId": "notificationControllerMarkAllAsReadPATCH", "summary": "Mark All As Read", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notifications.mark-all-as-read", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationController@markAllAsRead", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/notifications/metadata": { "get": { "tags": [ "Shared" ], "operationId": "notificationControllerMetadataGET", "summary": "Metadata", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notifications.metadata", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationController@metadata", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/notifications/poll": { "get": { "tags": [ "Shared" ], "operationId": "notificationStreamControllerPollGET", "summary": "Poll", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "notifications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "message": { "type": "string" }, "action_url": { "type": "string" }, "read_at": { "type": "null" }, "created_at": { "type": "string" } } } }, "has_more": { "type": "boolean" } } } } }, "example": { "success": true, "data": { "notifications": [ { "id": 101, "title": "Approval Required", "message": "Leave request #22 needs approval", "action_url": "/hr/employees/22", "read_at": null, "created_at": "2026-02-18T12:00:00Z" } ], "has_more": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notifications.poll", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationStreamController@poll", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/notifications/send-test": { "post": { "tags": [ "Shared" ], "operationId": "notificationControllerSendTestPOST", "summary": "Send Test", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notifications.send-test", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationController@sendTest", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "message": { "type": "string" }, "action_url": { "type": "string" } } }, "example": { "title": "Test Notification", "message": "This is a test notification from API.", "action_url": "/requests/123" } } } } } }, "/api/notifications/stream": { "get": { "tags": [ "Shared" ], "operationId": "notificationStreamControllerStreamGET", "summary": "Stream", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notifications.stream", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationStreamController@stream", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/notifications/unread-count": { "get": { "tags": [ "Shared" ], "operationId": "notificationControllerUnreadCountGET", "summary": "Unread Count", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "unread_count": { "type": "integer" } } } } }, "example": { "success": true, "data": { "unread_count": 3 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notifications.unread-count", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationController@unreadCount", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/notifications/{notification}": { "delete": { "tags": [ "Shared" ], "operationId": "notificationControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notifications.destroy", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "notification", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/notifications/{notification}/mark-as-read": { "patch": { "tags": [ "Shared" ], "operationId": "notificationControllerMarkAsReadPATCH", "summary": "Mark As Read", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "notifications.mark-as-read", "x-action": "App\\Domains\\Shared\\Controllers\\NotificationController@markAsRead", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "notification", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/permissions/assign-role": { "post": { "tags": [ "Identity" ], "operationId": "permissionControllerAssignRolePOST", "summary": "Assign Role", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@assignRole", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.assign_users|users.manage_permissions" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.assign_users", "users.manage_permissions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer" }, "role_name": { "type": "string" } } }, "example": { "user_id": 12, "role_name": "company_admin" } } } } } }, "/api/permissions/bulk-assign": { "post": { "tags": [ "Identity" ], "operationId": "permissionControllerBulkAssignRolesPOST", "summary": "Bulk Assign Roles", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@bulkAssignRoles", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.assign_users|users.manage_permissions" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.assign_users", "users.manage_permissions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_ids": { "type": "array", "items": { "type": "integer" } }, "role_name": { "type": "string" } } }, "example": { "user_ids": [ 12, 15 ], "role_name": "employee" } } } } } }, "/api/permissions/catalog": { "get": { "tags": [ "Identity" ], "operationId": "permissionControllerCatalogGET", "summary": "Catalog", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@catalog", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.view|permissions.view|roles.assign_permissions" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "permissions.view", "roles.assign_permissions", "roles.view" ] } }, "/api/permissions/me": { "get": { "tags": [ "Identity" ], "operationId": "permissionControllerMeGET", "summary": "Me", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@me", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/permissions/overview": { "get": { "tags": [ "Identity" ], "operationId": "permissionControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:permissions.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "permissions.view" ] } }, "/api/permissions/remove-role": { "delete": { "tags": [ "Identity" ], "operationId": "permissionControllerRemoveRoleDELETE", "summary": "Remove Role", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@removeRole", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.assign_users|users.manage_permissions" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.assign_users", "users.manage_permissions" ] } }, "/api/permissions/roles": { "get": { "tags": [ "Identity" ], "operationId": "permissionControllerListRolesGET", "summary": "List Roles", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@listRoles", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.view" ] } }, "/api/permissions/roles/{role}/permissions": { "get": { "tags": [ "Identity" ], "operationId": "permissionControllerListRolePermissionsGET", "summary": "List Role Permissions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@listRolePermissions", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.view" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/permissions/setup/{company}": { "post": { "tags": [ "Identity" ], "operationId": "permissionControllerSetupCompanyPermissionsPOST", "summary": "Setup Company Permissions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@setupCompanyPermissions", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:permissions.manage_categories" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "permissions.manage_categories" ], "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/permissions/user/{user}": { "get": { "tags": [ "Identity" ], "operationId": "permissionControllerGetUserPermissionsGET", "summary": "Get User Permissions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": true, "data": { "permissions": [ "users.view", "users.create", "roles.view" ], "roles": [ "super_admin", "company_admin", "employee" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\PermissionController@getUserPermissions", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage_permissions" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage_permissions" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/positions": { "get": { "tags": [ "Organization" ], "operationId": "positionManagementControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "code": { "type": "string" }, "department_id": { "type": "integer" } } } } } } } }, "example": { "success": true, "data": { "positions": [ { "id": 5, "title": "Senior Accountant", "code": "ACC-SR", "department_id": 3 } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "positions.index", "x-action": "App\\Domains\\Organization\\Controllers\\PositionManagementController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:positions.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "positions.view" ] }, "post": { "tags": [ "Organization" ], "operationId": "positionManagementControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "positions.store", "x-action": "App\\Domains\\Organization\\Controllers\\PositionManagementController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:positions.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "positions.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "code": { "type": "string" }, "department_id": { "type": "integer" }, "reports_to_position_id": { "type": "null" } } }, "example": { "title": "Senior Accountant", "code": "ACC-SR", "department_id": 3, "reports_to_position_id": null } } } } } }, "/api/positions/hierarchy": { "get": { "tags": [ "Organization" ], "operationId": "positionManagementControllerHierarchyGET", "summary": "Hierarchy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "code": { "type": "string" }, "department_id": { "type": "integer" } } } } } } } }, "example": { "success": true, "data": { "positions": [ { "id": 5, "title": "Senior Accountant", "code": "ACC-SR", "department_id": 3 } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "positions.hierarchy", "x-action": "App\\Domains\\Organization\\Controllers\\PositionManagementController@hierarchy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:positions.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "positions.view" ] } }, "/api/positions/{position}": { "delete": { "tags": [ "Organization" ], "operationId": "positionManagementControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "positions.destroy", "x-action": "App\\Domains\\Organization\\Controllers\\PositionManagementController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:positions.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "positions.delete" ], "parameters": [ { "name": "position", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Organization" ], "operationId": "positionManagementControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "code": { "type": "string" }, "department_id": { "type": "integer" } } } } } } } }, "example": { "success": true, "data": { "positions": [ { "id": 5, "title": "Senior Accountant", "code": "ACC-SR", "department_id": 3 } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "positions.show", "x-action": "App\\Domains\\Organization\\Controllers\\PositionManagementController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:positions.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "positions.view" ], "parameters": [ { "name": "position", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Organization" ], "operationId": "positionManagementControllerUpdatePUT", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "positions.update", "x-action": "App\\Domains\\Organization\\Controllers\\PositionManagementController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:positions.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "positions.edit" ], "parameters": [ { "name": "position", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "department_id": { "type": "integer" } } }, "example": { "title": "Lead Accountant", "department_id": 3 } } } } } }, "/api/roles": { "get": { "tags": [ "Identity" ], "operationId": "roleManagementControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } } } } } } }, "example": { "success": true, "data": { "roles": [ { "id": 3, "name": "company_admin", "permissions": [ "users.view", "users.create" ] } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.view" ] }, "post": { "tags": [ "Identity" ], "operationId": "roleManagementControllerStorePOST", "summary": "Store", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "example": { "name": "HR Manager", "description": "Manages HR operations", "permissions": [ "employees.view", "employees.edit", "departments.view" ] } } } } } }, "/api/roles/hierarchy": { "get": { "tags": [ "Identity" ], "operationId": "roleManagementControllerHierarchyGET", "summary": "Hierarchy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } } } } } } }, "example": { "success": true, "data": { "roles": [ { "id": 3, "name": "company_admin", "permissions": [ "users.view", "users.create" ] } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@hierarchy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.view" ] } }, "/api/roles/{role}": { "delete": { "tags": [ "Identity" ], "operationId": "roleManagementControllerDestroyDELETE", "summary": "Destroy", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.delete" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Identity" ], "operationId": "roleManagementControllerShowGET", "summary": "Show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } } } } } } }, "example": { "success": true, "data": { "roles": [ { "id": 3, "name": "company_admin", "permissions": [ "users.view", "users.create" ] } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.view" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Identity" ], "operationId": "roleManagementControllerUpdatePATCH", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.edit" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } }, "example": { "name": "Updated Role Name", "description": "Updated description" } } } } }, "put": { "tags": [ "Identity" ], "operationId": "roleManagementControllerUpdatePUT", "summary": "Update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.edit" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } }, "example": { "name": "Updated Role Name", "description": "Updated description" } } } } } }, "/api/roles/{role}/clone": { "post": { "tags": [ "Identity" ], "operationId": "roleManagementControllerClonePOST", "summary": "Clone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@clone", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.create" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } }, "example": { "name": "HR Manager Copy" } } } } } }, "/api/roles/{role}/permissions": { "patch": { "tags": [ "Identity" ], "operationId": "roleManagementControllerManagePermissionsPATCH", "summary": "Manage Permissions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@managePermissions", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.assign_permissions" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.assign_permissions" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "action": { "type": "string" } } }, "example": { "permissions": [ "users.view", "users.edit" ], "action": "sync" } } } } }, "post": { "tags": [ "Identity" ], "operationId": "roleManagementControllerManagePermissionsPOST", "summary": "Manage Permissions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@managePermissions", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.assign_permissions" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.assign_permissions" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "action": { "type": "string" } } }, "example": { "permissions": [ "users.view", "users.edit" ], "action": "sync" } } } } }, "put": { "tags": [ "Identity" ], "operationId": "roleManagementControllerManagePermissionsPUT", "summary": "Manage Permissions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@managePermissions", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.assign_permissions" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.assign_permissions" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } }, "action": { "type": "string" } } }, "example": { "permissions": [ "users.view", "users.edit" ], "action": "sync" } } } } } }, "/api/roles/{role}/users": { "delete": { "tags": [ "Identity" ], "operationId": "roleManagementControllerRemoveUsersDELETE", "summary": "Remove Users", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@removeUsers", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.remove_users" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.remove_users" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Identity" ], "operationId": "roleManagementControllerAssignUsersPOST", "summary": "Assign Users", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\RoleManagementController@assignUsers", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.assign_users" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.assign_users" ], "parameters": [ { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_ids": { "type": "array", "items": { "type": "integer" } } } }, "example": { "user_ids": [ 12, 15 ] } } } } } }, "/api/sidebar": { "get": { "tags": [ "Shared" ], "operationId": "navigationControllerGetSidebarGET", "summary": "Get Sidebar", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "menu": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "url": { "type": "string" }, "permission": { "type": "string" } } } } } } } } } } }, "example": { "success": true, "data": { "menu": [ { "id": "identity", "label": "Identity", "items": [ { "id": "users", "label": "Users", "url": "/users", "permission": "users.view" } ] } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": "api.navigation.sidebar", "x-action": "App\\Domains\\Shared\\Controllers\\NavigationController@getSidebar", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/system/info": { "get": { "tags": [ "Shared" ], "operationId": "routeGETApiSystemInfo", "summary": "GET /api/system/info", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "Closure", "x-middleware": [ "api" ] } }, "/api/system/settings": { "get": { "tags": [ "Shared" ], "operationId": "systemSettingsControllerIndexGET", "summary": "Index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Shared\\Controllers\\SystemSettingsController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:system.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "system.settings.view" ] } }, "/api/users": { "get": { "tags": [ "Identity" ], "operationId": "userManagementControllerListUsersGET", "summary": "List Users", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" }, "is_active": { "type": "boolean" }, "account_status": { "type": "string" }, "status": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "company_access": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "string" }, "is_primary": { "type": "boolean" }, "is_active": { "type": "boolean" }, "joined_at": { "type": "string" }, "left_at": { "type": "null" }, "suspension": { "type": "null" }, "access_lock": { "type": "null" } } } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "example": { "success": true, "data": { "users": [ { "id": 12, "name": "John Manager", "email": "john.manager@example.com", "is_active": true, "account_status": "active", "status": "active", "roles": [ "company_admin" ], "company_access": { "id": 1, "name": "Acme Medical", "code": "ACME", "status": "active", "is_primary": true, "is_active": true, "joined_at": "2026-02-18T12:00:00Z", "left_at": null, "suspension": null, "access_lock": null } } ], "pagination": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@listUsers", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.view" ] }, "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerCreateUserPOST", "summary": "Create User", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" }, "current_company_id": { "type": "integer" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "employee": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "company_id": { "type": "integer" }, "employee_code": { "type": "string" }, "is_active": { "type": "boolean" } } } } } } }, "example": { "success": true, "message": "User created successfully", "data": { "user": { "id": 12, "name": "John Manager", "email": "john.manager@example.com", "current_company_id": 1, "roles": [ "company_admin" ] }, "employee": { "id": 33, "user_id": 12, "company_id": 1, "employee_code": "EMP-1001", "is_active": true } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@createUser", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "is_employee": { "type": "boolean" }, "employee_data": { "type": "object", "properties": { "employee_code": { "type": "string" } } } } }, "example": { "name": "John Manager", "email": "john.manager@example.com", "password": "Password123!", "roles": [ "company_admin" ], "is_employee": true, "employee_data": { "employee_code": "EMP-1001" } } } } } } }, "/api/users/bulk-create": { "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerBulkCreateUsersPOST", "summary": "Bulk Create Users", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@bulkCreateUsers", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "role": { "type": "string" } } } } } }, "example": { "users": [ { "name": "User One", "email": "user1@example.com", "password": "Password123!", "role": "company_admin" }, { "name": "User Two", "email": "user2@example.com", "password": "Password123!", "role": "employee" } ] } } } } } }, "/api/users/bulk-update": { "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerBulkUpdateUsersPOST", "summary": "Bulk Update Users", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@bulkUpdateUsers", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.activate|users.suspend|users.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.activate", "users.delete", "users.suspend" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_ids": { "type": "array", "items": { "type": "integer" } }, "action": { "type": "string" } } }, "example": { "user_ids": [ 12, 15, 18 ], "action": "suspend" } } } } } }, "/api/users/{user}": { "get": { "tags": [ "Identity" ], "operationId": "userManagementControllerShowUserGET", "summary": "Show User", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@showUser", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.view" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Identity" ], "operationId": "userManagementControllerUpdateUserPUT", "summary": "Update User", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@updateUser", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.edit" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.edit" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "timezone": { "type": "string" } } }, "example": { "name": "Updated User Name", "email": "updated.user@example.com", "timezone": "UTC" } } } } } }, "/api/users/{user}/activate": { "put": { "tags": [ "Identity" ], "operationId": "userManagementControllerActivateUserPUT", "summary": "Activate User", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@activateUser", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.activate" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.activate" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reset_password": { "type": "boolean" } } }, "example": { "reset_password": true } } } } } }, "/api/users/{user}/companies": { "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerAddUserToCompanyPOST", "summary": "Add User To Company", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@addUserToCompany", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "company_id": { "type": "integer" }, "roles": { "type": "array", "items": { "type": "string" } }, "is_primary": { "type": "boolean" }, "create_employee": { "type": "boolean" }, "employee_data": { "type": "object", "properties": { "employee_code": { "type": "string" } } } } }, "example": { "company_id": 2, "roles": [ "employee" ], "is_primary": false, "create_employee": true, "employee_data": { "employee_code": "EMP-2001" } } } } } } }, "/api/users/{user}/companies/{company}": { "delete": { "tags": [ "Identity" ], "operationId": "userManagementControllerRemoveUserFromCompanyDELETE", "summary": "Remove User From Company", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@removeUserFromCompany", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/users/{user}/companies/{company}/primary": { "put": { "tags": [ "Identity" ], "operationId": "userManagementControllerSetPrimaryCompanyPUT", "summary": "Set Primary Company", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@setPrimaryCompany", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/users/{user}/companies/{company}/roles": { "put": { "tags": [ "Identity" ], "operationId": "userManagementControllerUpdateUserCompanyRolesPUT", "summary": "Update User Company Roles", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@updateUserCompanyRoles", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:roles.assign_users" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "roles.assign_users" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } } } }, "example": { "roles": [ "company_admin" ] } } } } } }, "/api/users/{user}/employee": { "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerCreateEmployeeProfilePOST", "summary": "Create Employee Profile", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@createEmployeeProfile", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:employees.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.create" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_code": { "type": "string" } } }, "example": { "employee_code": "EMP-1002" } } } } } }, "/api/users/{user}/lock": { "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerLockUserPOST", "summary": "Lock User", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@lockUser", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage_security" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage_security" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string" }, "lock_until": { "type": "string" } } }, "example": { "reason": "Suspicious login activity", "lock_until": "2026-12-31T23:59:59Z" } } } } } }, "/api/users/{user}/reset-password": { "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerResetPasswordPOST", "summary": "Reset Password", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@resetPassword", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage_security" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage_security" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "new_password": { "type": "string" }, "force_password_change": { "type": "boolean" } } }, "example": { "new_password": "Password123!", "force_password_change": true } } } } } }, "/api/users/{user}/sessions": { "delete": { "tags": [ "Identity" ], "operationId": "userManagementControllerForceLogoutUserDELETE", "summary": "Force Logout User", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@forceLogoutUser", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage_security" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage_security" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Identity" ], "operationId": "userManagementControllerGetUserSessionsGET", "summary": "Get User Sessions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "example": { "success": true, "message": "Request completed successfully", "data": { "result": { "id": 1, "name": "Sample Resource" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@getUserSessions", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage_security" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage_security" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/users/{user}/sessions/{session}": { "delete": { "tags": [ "Identity" ], "operationId": "userManagementControllerForceLogoutUserSessionDELETE", "summary": "Force Logout User Session", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource deleted successfully", "data": { "id": 100, "status": "deleted" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@forceLogoutUserSession", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage_security" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage_security" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "session", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/users/{user}/set-password": { "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerSetPasswordPOST", "summary": "Set Password", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@setPassword", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage_security" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage_security" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string" }, "password_confirmation": { "type": "string" }, "force_password_change": { "type": "boolean" }, "notify_user": { "type": "boolean" } } }, "example": { "password": "Password123!", "password_confirmation": "Password123!", "force_password_change": true, "notify_user": false } } } } } }, "/api/users/{user}/suspend": { "put": { "tags": [ "Identity" ], "operationId": "userManagementControllerSuspendUserPUT", "summary": "Suspend User", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Resource updated successfully", "data": { "id": 100, "status": "updated" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@suspendUser", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.suspend" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.suspend" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string" }, "suspended_until": { "type": "string" }, "notify_user": { "type": "boolean" } } }, "example": { "reason": "Policy violation", "suspended_until": "2026-12-31", "notify_user": true } } } } } }, "/api/users/{user}/transfer": { "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerTransferUserBetweenCompaniesPOST", "summary": "Transfer User Between Companies", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@transferUserBetweenCompanies", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.transfer" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.transfer" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from_company_id": { "type": "integer" }, "to_company_id": { "type": "integer" }, "make_primary": { "type": "boolean" }, "keep_access_to_old": { "type": "boolean" }, "transfer_employee_record": { "type": "boolean" }, "new_roles": { "type": "array", "items": { "type": "string" } }, "employee_data": { "type": "object", "properties": { "new_employee_code": { "type": "string" }, "transfer_date": { "type": "string" } } } } }, "example": { "from_company_id": 1, "to_company_id": 2, "make_primary": true, "keep_access_to_old": false, "transfer_employee_record": true, "new_roles": [ "employee" ], "employee_data": { "new_employee_code": "EMP-3001", "transfer_date": "2026-02-01" } } } } } } }, "/api/users/{user}/unlock": { "post": { "tags": [ "Identity" ], "operationId": "userManagementControllerUnlockUserPOST", "summary": "Unlock User", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } }, "example": { "success": true, "message": "Operation completed successfully", "data": { "id": 100, "status": "created" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unexpected server error" } } } } }, "x-route-name": null, "x-action": "App\\Domains\\Identity\\Controllers\\UserManagementController@unlockUser", "x-middleware": [ "api", "auth:sanctum", "company.context", "permission:users.manage_security" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "users.manage_security" ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } } } }