{ "openapi": "3.1.0", "info": { "title": "TractosERP API", "version": "1.0.0", "description": "Generated from Laravel route map." }, "servers": [ { "url": "https://erp-api.tractos.net" } ], "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/assistant/conversations": { "get": { "tags": [ "Shared" ], "operationId": "assistantConversationControllerIndexGET", "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": "assistant.conversations.index", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantConversationController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.chat.use" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.chat.use" ] }, "post": { "tags": [ "Shared" ], "operationId": "assistantConversationControllerStorePOST", "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": "assistant.conversations.store", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantConversationController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.chat.use" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.chat.use" ], "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/assistant/conversations/{uuid}": { "delete": { "tags": [ "Shared" ], "operationId": "assistantConversationControllerDestroyDELETE", "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": "assistant.conversations.destroy", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantConversationController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.chat.use" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.chat.use" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "assistantConversationControllerShowGET", "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": "assistant.conversations.show", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantConversationController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.chat.use" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.chat.use" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/assistant/conversations/{uuid}/messages": { "get": { "tags": [ "Shared" ], "operationId": "assistantMessageControllerIndexGET", "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": "assistant.conversations.messages.index", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantMessageController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.chat.use" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.chat.use" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "assistantMessageControllerStorePOST", "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": "assistant.conversations.messages.store", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantMessageController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.chat.use" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.chat.use" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/assistant/logs/conversations": { "get": { "tags": [ "Shared" ], "operationId": "assistantAuditControllerIndexGET", "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": "assistant.logs.conversations.index", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantAuditController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.audit.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.audit.view" ] } }, "/api/assistant/logs/conversations/export.csv": { "get": { "tags": [ "Shared" ], "operationId": "assistantAuditControllerExportConversationSummariesGET", "summary": "Export Conversation Summaries", "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": "assistant.logs.conversations.export", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantAuditController@exportConversationSummaries", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.audit.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.audit.view" ] } }, "/api/assistant/logs/conversations/{uuid}": { "get": { "tags": [ "Shared" ], "operationId": "assistantAuditControllerShowGET", "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": "assistant.logs.conversations.show", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantAuditController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.audit.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.audit.view" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/assistant/logs/conversations/{uuid}/export.csv": { "get": { "tags": [ "Shared" ], "operationId": "assistantAuditControllerExportConversationTransactionsGET", "summary": "Export Conversation Transactions", "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": "assistant.logs.conversations.transactions.export", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantAuditController@exportConversationTransactions", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.audit.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.audit.view" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/assistant/settings": { "get": { "tags": [ "Shared" ], "operationId": "assistantSettingsControllerShowGET", "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": "assistant.settings.show", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantSettingsController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.settings.view|assistant.chat.use" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.chat.use", "assistant.settings.view" ] }, "put": { "tags": [ "Shared" ], "operationId": "assistantSettingsControllerUpdatePUT", "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": "assistant.settings.update", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantSettingsController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.settings.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/assistant/settings/custom-gpt/keys": { "get": { "tags": [ "Shared" ], "operationId": "assistantCustomGptKeyControllerIndexGET", "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": "assistant.settings.custom-gpt.keys.index", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantCustomGptKeyController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.custom_gpt.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.custom_gpt.manage" ] }, "post": { "tags": [ "Shared" ], "operationId": "assistantCustomGptKeyControllerStorePOST", "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": "assistant.settings.custom-gpt.keys.store", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantCustomGptKeyController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.custom_gpt.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.custom_gpt.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/assistant/settings/custom-gpt/keys/{uuid}": { "delete": { "tags": [ "Shared" ], "operationId": "assistantCustomGptKeyControllerDestroyDELETE", "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": "assistant.settings.custom-gpt.keys.destroy", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantCustomGptKeyController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.custom_gpt.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.custom_gpt.manage" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/assistant/settings/provider-chain": { "put": { "tags": [ "Shared" ], "operationId": "assistantSettingsControllerUpdateProviderChainPUT", "summary": "Update Provider Chain", "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": "assistant.settings.provider-chain.update", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantSettingsController@updateProviderChain", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.settings.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/assistant/settings/providers/{provider}/key": { "delete": { "tags": [ "Shared" ], "operationId": "assistantSettingsControllerDestroyProviderKeyDELETE", "summary": "Destroy Provider Key", "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": "assistant.settings.providers.key.destroy", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantSettingsController@destroyProviderKey", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.provider_keys.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.provider_keys.manage" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "assistantSettingsControllerStoreProviderKeyPOST", "summary": "Store Provider Key", "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": "assistant.settings.providers.key.store", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantSettingsController@storeProviderKey", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.provider_keys.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.provider_keys.manage" ], "parameters": [ { "name": "provider", "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/assistant/settings/providers/{provider}/test": { "post": { "tags": [ "Shared" ], "operationId": "assistantSettingsControllerTestProviderPOST", "summary": "Test Provider", "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": "assistant.settings.providers.test", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantSettingsController@testProvider", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.settings.manage" ], "parameters": [ { "name": "provider", "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/assistant/usage": { "get": { "tags": [ "Shared" ], "operationId": "assistantSettingsControllerUsageGET", "summary": "Usage", "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": "assistant.usage", "x-action": "App\\Domains\\Assistant\\Controllers\\AssistantSettingsController@usage", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:assistant", "permission:assistant.chat.use" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "assistant.chat.use" ] } }, "/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@tractos.net" }, "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/avatar": { "post": { "tags": [ "Identity" ], "operationId": "authControllerUploadAvatarPOST", "summary": "Upload Avatar", "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@uploadAvatar", "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/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@tractos.net" }, "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@tractos.net", "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@tractos.net" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "request": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Bad request", "errors": { "request": [ "The request payload is invalid." ] } } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Unauthenticated" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "example": { "success": false, "message": "Resource not found" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "retry_after": { "type": "integer" } } }, "example": { "success": false, "message": "Too many requests", "retry_after": 60 } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "success": false, "message": "Validation error", "errors": { "email": [ "The email field is required." ] } } } } }, "500": { "description": "Server 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/clinical/appointments": { "get": { "tags": [ "Shared" ], "operationId": "appointmentControllerIndexGET", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "appointmentControllerStorePOST", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.create" ], "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/clinical/appointments/availability": { "get": { "tags": [ "Shared" ], "operationId": "appointmentControllerAvailableSlotsGET", "summary": "Available Slots", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@availableSlots", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.view" ] } }, "/api/clinical/appointments/export.csv": { "get": { "tags": [ "Shared" ], "operationId": "appointmentControllerExportCsvGET", "summary": "Export Csv", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@exportCsv", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.view" ] } }, "/api/clinical/appointments/{appointment}": { "get": { "tags": [ "Shared" ], "operationId": "appointmentControllerShowGET", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.view" ], "parameters": [ { "name": "appointment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "appointmentControllerReschedulePATCH", "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": "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\\Clinical\\Appointments\\Controllers\\AppointmentController@reschedule", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.update" ], "parameters": [ { "name": "appointment", "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." } } } } }, "put": { "tags": [ "Shared" ], "operationId": "appointmentControllerUpdatePUT", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.update" ], "parameters": [ { "name": "appointment", "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/clinical/appointments/{appointment}/arrive": { "post": { "tags": [ "Shared" ], "operationId": "appointmentControllerArrivePOST", "summary": "Arrive", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@arrive", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.update" ], "parameters": [ { "name": "appointment", "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/clinical/appointments/{appointment}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "appointmentControllerCancelPOST", "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": null, "x-action": "App\\Domains\\Clinical\\Appointments\\Controllers\\AppointmentController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.cancel" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.cancel" ], "parameters": [ { "name": "appointment", "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/clinical/appointments/{appointment}/confirm": { "post": { "tags": [ "Shared" ], "operationId": "appointmentControllerConfirmPOST", "summary": "Confirm", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@confirm", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.update" ], "parameters": [ { "name": "appointment", "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/clinical/appointments/{appointment}/no-answer": { "post": { "tags": [ "Shared" ], "operationId": "appointmentControllerMarkNoAnswerPOST", "summary": "Mark No Answer", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@markNoAnswer", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.cancel" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.cancel" ], "parameters": [ { "name": "appointment", "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/clinical/appointments/{appointment}/no-show": { "post": { "tags": [ "Shared" ], "operationId": "appointmentControllerMarkNoShowPOST", "summary": "Mark No Show", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@markNoShow", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.cancel" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.cancel" ], "parameters": [ { "name": "appointment", "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/clinical/appointments/{appointment}/status": { "post": { "tags": [ "Shared" ], "operationId": "appointmentControllerUpdateStatusPOST", "summary": "Update Status", "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\\Clinical\\Appointments\\Controllers\\AppointmentController@updateStatus", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.update" ], "parameters": [ { "name": "appointment", "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/clinical/bill-field-definitions": { "get": { "tags": [ "Shared" ], "operationId": "billFieldDefinitionControllerIndexGET", "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\\Clinical\\Billing\\Controllers\\BillFieldDefinitionController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "billFieldDefinitionControllerStorePOST", "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\\Clinical\\Billing\\Controllers\\BillFieldDefinitionController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/bill-field-definitions/reorder": { "post": { "tags": [ "Shared" ], "operationId": "billFieldDefinitionControllerReorderPOST", "summary": "Reorder", "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\\Clinical\\Billing\\Controllers\\BillFieldDefinitionController@reorder", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/bill-field-definitions/{billFieldDefinition}": { "delete": { "tags": [ "Shared" ], "operationId": "billFieldDefinitionControllerDestroyDELETE", "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\\Clinical\\Billing\\Controllers\\BillFieldDefinitionController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "billFieldDefinition", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "billFieldDefinitionControllerUpdatePATCH", "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\\Clinical\\Billing\\Controllers\\BillFieldDefinitionController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "billFieldDefinition", "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/clinical/billing/dashboard": { "get": { "tags": [ "Shared" ], "operationId": "billingControllerDashboardGET", "summary": "Dashboard", "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\\Clinical\\Billing\\Controllers\\BillingController@dashboard", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.view" ] } }, "/api/clinical/billing/ready-encounters": { "get": { "tags": [ "Shared" ], "operationId": "billingControllerReadyEncountersGET", "summary": "Ready Encounters", "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\\Clinical\\Billing\\Controllers\\BillingController@readyEncounters", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.view" ] } }, "/api/clinical/bills": { "get": { "tags": [ "Shared" ], "operationId": "billingControllerIndexGET", "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\\Clinical\\Billing\\Controllers\\BillingController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "billingControllerStorePOST", "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\\Clinical\\Billing\\Controllers\\BillingController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.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/clinical/bills/{bill}": { "get": { "tags": [ "Shared" ], "operationId": "billingControllerShowGET", "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\\Clinical\\Billing\\Controllers\\BillingController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.view" ], "parameters": [ { "name": "bill", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "billingControllerUpdatePATCH", "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\\Clinical\\Billing\\Controllers\\BillingController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.manage" ], "parameters": [ { "name": "bill", "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/clinical/bills/{bill}/allocate-advance": { "post": { "tags": [ "Shared" ], "operationId": "paymentControllerAllocateAdvancePOST", "summary": "Allocate Advance", "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\\Clinical\\Billing\\Controllers\\PaymentController@allocateAdvance", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.payments.post" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.payments.post" ], "parameters": [ { "name": "bill", "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/clinical/bills/{bill}/available-orders": { "get": { "tags": [ "Shared" ], "operationId": "billingControllerAvailableOrdersGET", "summary": "Available Orders", "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\\Clinical\\Billing\\Controllers\\BillingController@availableOrders", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.view" ], "parameters": [ { "name": "bill", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/bills/{bill}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "billingControllerFinalizePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Billing\\Controllers\\BillingController@finalize", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.finalize" ], "parameters": [ { "name": "bill", "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/clinical/bills/{bill}/items": { "post": { "tags": [ "Shared" ], "operationId": "billingControllerAddItemPOST", "summary": "Add Item", "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\\Clinical\\Billing\\Controllers\\BillingController@addItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.manage" ], "parameters": [ { "name": "bill", "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/clinical/bills/{bill}/items/{item}": { "delete": { "tags": [ "Shared" ], "operationId": "billingControllerDeleteItemDELETE", "summary": "Delete Item", "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\\Clinical\\Billing\\Controllers\\BillingController@deleteItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.manage" ], "parameters": [ { "name": "bill", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "billingControllerUpdateItemPATCH", "summary": "Update Item", "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\\Clinical\\Billing\\Controllers\\BillingController@updateItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.manage" ], "parameters": [ { "name": "bill", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "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/clinical/bills/{bill}/payments": { "post": { "tags": [ "Shared" ], "operationId": "paymentControllerPostBillPaymentPOST", "summary": "Post Bill Payment", "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\\Clinical\\Billing\\Controllers\\PaymentController@postBillPayment", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.payments.post" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.payments.post" ], "parameters": [ { "name": "bill", "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/clinical/bills/{bill}/print-pdf": { "get": { "tags": [ "Shared" ], "operationId": "billPrintControllerPdfGET", "summary": "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": null, "x-action": "App\\Domains\\Clinical\\Billing\\Controllers\\BillPrintController@pdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.view" ], "parameters": [ { "name": "bill", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/bills/{bill}/pull-orders": { "post": { "tags": [ "Shared" ], "operationId": "billingControllerPullOrdersPOST", "summary": "Pull Orders", "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\\Clinical\\Billing\\Controllers\\BillingController@pullOrders", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.manage" ], "parameters": [ { "name": "bill", "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/clinical/bills/{bill}/refunds": { "post": { "tags": [ "Shared" ], "operationId": "paymentControllerRefundBillPOST", "summary": "Refund Bill", "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\\Clinical\\Billing\\Controllers\\PaymentController@refundBill", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.refunds.post" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.refunds.post" ], "parameters": [ { "name": "bill", "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/clinical/bills/{bill}/void": { "post": { "tags": [ "Shared" ], "operationId": "billingControllerVoidPOST", "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": "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\\Clinical\\Billing\\Controllers\\BillingController@void", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.void" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.void" ], "parameters": [ { "name": "bill", "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/clinical/emr/doctor/queue": { "get": { "tags": [ "Shared" ], "operationId": "emrQueueControllerDoctorQueueGET", "summary": "Doctor Queue", "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\\Clinical\\Emr\\Controllers\\EmrQueueController@doctorQueue", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view" ] } }, "/api/clinical/emr/nursing/queue": { "get": { "tags": [ "Shared" ], "operationId": "emrQueueControllerNursingQueueGET", "summary": "Nursing Queue", "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\\Clinical\\Emr\\Controllers\\EmrQueueController@nursingQueue", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.view" ] } }, "/api/clinical/encounters/{encounter}": { "get": { "tags": [ "Shared" ], "operationId": "encounterControllerShowGET", "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\\Clinical\\Emr\\Controllers\\EncounterController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/encounters/{encounter}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "encounterControllerCancelPOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\EncounterController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reception.cancel_encounter" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reception.cancel_encounter" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/consultation/complete": { "post": { "tags": [ "Shared" ], "operationId": "encounterControllerConsultationCompletePOST", "summary": "Consultation Complete", "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\\Clinical\\Emr\\Controllers\\EncounterController@consultationComplete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/consultation/start": { "post": { "tags": [ "Shared" ], "operationId": "encounterControllerConsultationStartPOST", "summary": "Consultation Start", "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\\Clinical\\Emr\\Controllers\\EncounterController@consultationStart", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/diagnoses": { "get": { "tags": [ "Shared" ], "operationId": "diagnosisControllerIndexGET", "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\\Clinical\\Emr\\Controllers\\DiagnosisController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "diagnosisControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\DiagnosisController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/diagnoses/{diagnosis}": { "delete": { "tags": [ "Shared" ], "operationId": "diagnosisControllerVoidDELETE", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\DiagnosisController@void", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "diagnosis", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "diagnosisControllerShowGET", "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\\Clinical\\Emr\\Controllers\\DiagnosisController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "diagnosis", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "diagnosisControllerUpdatePATCH", "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\\Clinical\\Emr\\Controllers\\DiagnosisController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "diagnosis", "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/clinical/encounters/{encounter}/doctor-notes": { "get": { "tags": [ "Shared" ], "operationId": "doctorNoteControllerIndexGET", "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\\Clinical\\Emr\\Controllers\\DoctorNoteController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "doctorNoteControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\DoctorNoteController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/doctor-notes/{note}": { "get": { "tags": [ "Shared" ], "operationId": "doctorNoteControllerShowGET", "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\\Clinical\\Emr\\Controllers\\DoctorNoteController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "doctorNoteControllerUpdatePATCH", "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\\Clinical\\Emr\\Controllers\\DoctorNoteController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note", "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/clinical/encounters/{encounter}/doctor-notes/{note}/addenda": { "post": { "tags": [ "Shared" ], "operationId": "doctorNoteControllerAddendumPOST", "summary": "Addendum", "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\\Clinical\\Emr\\Controllers\\DoctorNoteController@addendum", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.addenda.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.addenda.create" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note", "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/clinical/encounters/{encounter}/doctor-notes/{note}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "doctorNoteControllerFinalizePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\DoctorNoteController@finalize", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note", "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/clinical/encounters/{encounter}/indents": { "get": { "tags": [ "Shared" ], "operationId": "billingIndentControllerIndexGET", "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\\Clinical\\Billing\\Controllers\\BillingIndentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "billingIndentControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Billing\\Controllers\\BillingIndentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.orders.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.orders.create" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/indents/{indent}/bill-items": { "post": { "tags": [ "Shared" ], "operationId": "billingIndentControllerBillItemsPOST", "summary": "Bill Items", "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\\Clinical\\Billing\\Controllers\\BillingIndentController@billItems", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.manage" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "indent", "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/clinical/encounters/{encounter}/indents/{indent}/items": { "post": { "tags": [ "Shared" ], "operationId": "billingIndentControllerAddItemPOST", "summary": "Add Item", "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\\Clinical\\Billing\\Controllers\\BillingIndentController@addItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.orders.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.orders.create" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "indent", "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/clinical/encounters/{encounter}/indents/{indent}/items/{item}": { "delete": { "tags": [ "Shared" ], "operationId": "billingIndentControllerRemoveItemDELETE", "summary": "Remove Item", "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\\Clinical\\Billing\\Controllers\\BillingIndentController@removeItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.orders.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.orders.create" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "indent", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/encounters/{encounter}/indents/{indent}/submit": { "post": { "tags": [ "Shared" ], "operationId": "billingIndentControllerSubmitPOST", "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": null, "x-action": "App\\Domains\\Clinical\\Billing\\Controllers\\BillingIndentController@submit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.orders.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.orders.create" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "indent", "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/clinical/encounters/{encounter}/nursing-notes": { "get": { "tags": [ "Shared" ], "operationId": "nursingNoteControllerIndexGET", "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\\Clinical\\Emr\\Controllers\\NursingNoteController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "nursingNoteControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\NursingNoteController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/nursing-notes/{note}": { "get": { "tags": [ "Shared" ], "operationId": "nursingNoteControllerShowGET", "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\\Clinical\\Emr\\Controllers\\NursingNoteController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "nursingNoteControllerUpdatePATCH", "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\\Clinical\\Emr\\Controllers\\NursingNoteController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.write" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note", "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/clinical/encounters/{encounter}/nursing-notes/{note}/addenda": { "post": { "tags": [ "Shared" ], "operationId": "nursingNoteControllerAddendumPOST", "summary": "Addendum", "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\\Clinical\\Emr\\Controllers\\NursingNoteController@addendum", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.addenda.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.addenda.create" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note", "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/clinical/encounters/{encounter}/nursing-notes/{note}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "nursingNoteControllerFinalizePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\NursingNoteController@finalize", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.write" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note", "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/clinical/encounters/{encounter}/nursing/complete": { "post": { "tags": [ "Shared" ], "operationId": "encounterControllerNursingCompletePOST", "summary": "Nursing Complete", "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\\Clinical\\Emr\\Controllers\\EncounterController@nursingComplete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/nursing/start": { "post": { "tags": [ "Shared" ], "operationId": "encounterControllerNursingStartPOST", "summary": "Nursing Start", "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\\Clinical\\Emr\\Controllers\\EncounterController@nursingStart", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/prescriptions": { "get": { "tags": [ "Shared" ], "operationId": "prescriptionControllerIndexGET", "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\\Clinical\\Emr\\Controllers\\PrescriptionController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "prescriptionControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\PrescriptionController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/prescriptions/{prescription}": { "delete": { "tags": [ "Shared" ], "operationId": "prescriptionControllerVoidDELETE", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\PrescriptionController@void", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "prescription", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "prescriptionControllerShowGET", "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\\Clinical\\Emr\\Controllers\\PrescriptionController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "prescription", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/encounters/{encounter}/prescriptions/{prescription}/stop": { "post": { "tags": [ "Shared" ], "operationId": "prescriptionControllerStopPOST", "summary": "Stop", "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\\Clinical\\Emr\\Controllers\\PrescriptionController@stop", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "prescription", "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/clinical/encounters/{encounter}/print-pdf": { "get": { "tags": [ "Shared" ], "operationId": "encounterPrintControllerEncounterPdfGET", "summary": "Encounter 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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\EncounterPrintController@encounterPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.view|clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view", "clinical.emr.nursing.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/encounters/{encounter}/print-pdf-with-history": { "get": { "tags": [ "Shared" ], "operationId": "encounterPrintControllerEncounterWithHistoryPdfGET", "summary": "Encounter With History 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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\EncounterPrintController@encounterWithHistoryPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.view|clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view", "clinical.emr.nursing.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/encounters/{encounter}/ready-for-billing": { "post": { "tags": [ "Shared" ], "operationId": "encounterControllerMarkReadyForBillingPOST", "summary": "Mark Ready For Billing", "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\\Clinical\\Emr\\Controllers\\EncounterController@markReadyForBilling", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.complete_encounter" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.complete_encounter" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/reopen": { "post": { "tags": [ "Shared" ], "operationId": "encounterControllerReopenPOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\EncounterController@reopen", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/service-orders": { "get": { "tags": [ "Shared" ], "operationId": "serviceOrderControllerIndexGET", "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\\Clinical\\Emr\\Controllers\\ServiceOrderController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.orders.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.orders.create" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "serviceOrderControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\ServiceOrderController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.orders.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.orders.create" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/service-orders/{serviceOrder}": { "get": { "tags": [ "Shared" ], "operationId": "serviceOrderControllerShowGET", "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\\Clinical\\Emr\\Controllers\\ServiceOrderController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.orders.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.orders.create" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "serviceOrder", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/encounters/{encounter}/service-orders/{serviceOrder}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "serviceOrderControllerCancelPOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\ServiceOrderController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.orders.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.orders.create" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "serviceOrder", "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/clinical/encounters/{encounter}/service-orders/{serviceOrder}/complete": { "post": { "tags": [ "Shared" ], "operationId": "serviceOrderControllerCompletePOST", "summary": "Complete", "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\\Clinical\\Emr\\Controllers\\ServiceOrderController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.orders.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.orders.create" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "serviceOrder", "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/clinical/encounters/{encounter}/service-orders/{serviceOrder}/consume-package": { "post": { "tags": [ "Shared" ], "operationId": "patientPackageControllerConsumeServiceOrderPOST", "summary": "Consume Service Order", "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\\Clinical\\Billing\\Controllers\\PatientPackageController@consumeServiceOrder", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patient_packages.consume" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patient_packages.consume" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "serviceOrder", "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/clinical/encounters/{encounter}/status": { "post": { "tags": [ "Shared" ], "operationId": "encounterControllerUpdateStatusPOST", "summary": "Update Status", "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\\Clinical\\Emr\\Controllers\\EncounterController@updateStatus", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/summary": { "get": { "tags": [ "Shared" ], "operationId": "encounterSummaryControllerShowGET", "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\\Clinical\\Emr\\Controllers\\EncounterSummaryController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.view|clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view", "clinical.emr.nursing.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/encounters/{encounter}/vitals": { "get": { "tags": [ "Shared" ], "operationId": "vitalsControllerIndexGET", "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\\Clinical\\Emr\\Controllers\\VitalsController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "vitalsControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Emr\\Controllers\\VitalsController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.write" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.write" ], "parameters": [ { "name": "encounter", "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/clinical/encounters/{encounter}/vitals/{vitals}": { "get": { "tags": [ "Shared" ], "operationId": "vitalsControllerShowGET", "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\\Clinical\\Emr\\Controllers\\VitalsController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.nursing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.nursing.view" ], "parameters": [ { "name": "encounter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vitals", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/packages": { "get": { "tags": [ "Shared" ], "operationId": "servicePackageControllerIndexGET", "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\\Clinical\\Billing\\Controllers\\ServicePackageController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.packages.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.packages.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "servicePackageControllerStorePOST", "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\\Clinical\\Billing\\Controllers\\ServicePackageController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.packages.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.packages.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/clinical/packages/{package}": { "get": { "tags": [ "Shared" ], "operationId": "servicePackageControllerShowGET", "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\\Clinical\\Billing\\Controllers\\ServicePackageController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.packages.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.packages.view" ], "parameters": [ { "name": "package", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "servicePackageControllerUpdatePATCH", "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\\Clinical\\Billing\\Controllers\\ServicePackageController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.packages.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.packages.manage" ], "parameters": [ { "name": "package", "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/clinical/packages/{package}/activate": { "post": { "tags": [ "Shared" ], "operationId": "servicePackageControllerActivatePOST", "summary": "Activate", "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\\Clinical\\Billing\\Controllers\\ServicePackageController@activate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.packages.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.packages.manage" ], "parameters": [ { "name": "package", "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/clinical/packages/{package}/deactivate": { "post": { "tags": [ "Shared" ], "operationId": "servicePackageControllerDeactivatePOST", "summary": "Deactivate", "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\\Clinical\\Billing\\Controllers\\ServicePackageController@deactivate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.packages.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.packages.manage" ], "parameters": [ { "name": "package", "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/clinical/patients": { "get": { "tags": [ "Shared" ], "operationId": "patientControllerIndexGET", "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\\Clinical\\Patients\\Controllers\\PatientController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "patientControllerStorePOST", "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\\Clinical\\Patients\\Controllers\\PatientController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.create" ], "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/clinical/patients/search-duplicates": { "get": { "tags": [ "Shared" ], "operationId": "patientControllerSearchDuplicatesGET", "summary": "Search Duplicates", "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\\Clinical\\Patients\\Controllers\\PatientController@searchDuplicates", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ] } }, "/api/clinical/patients/{patient}": { "get": { "tags": [ "Shared" ], "operationId": "patientControllerShowGET", "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\\Clinical\\Patients\\Controllers\\PatientController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "patientControllerUpdatePATCH", "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\\Clinical\\Patients\\Controllers\\PatientController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/account-summary": { "get": { "tags": [ "Shared" ], "operationId": "ledgerControllerAccountSummaryGET", "summary": "Account 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\\Clinical\\Billing\\Controllers\\LedgerController@accountSummary", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.ledger.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.ledger.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/active-medications": { "get": { "tags": [ "Shared" ], "operationId": "activeMedicationsControllerIndexGET", "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\\Clinical\\Patients\\Controllers\\ActiveMedicationsController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.emr.doctor.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.emr.doctor.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/advance-receipts": { "get": { "tags": [ "Shared" ], "operationId": "advanceReceiptControllerIndexGET", "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\\Clinical\\Billing\\Controllers\\AdvanceReceiptController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "advanceReceiptControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Billing\\Controllers\\AdvanceReceiptController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.payments.post" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.payments.post" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/advance-receipts/{advanceReceipt}/apply": { "post": { "tags": [ "Shared" ], "operationId": "advanceReceiptControllerApplyPOST", "summary": "Apply", "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\\Clinical\\Billing\\Controllers\\AdvanceReceiptController@apply", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.payments.post" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.payments.post" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advanceReceipt", "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/clinical/patients/{patient}/advance-receipts/{advanceReceipt}/void": { "post": { "tags": [ "Shared" ], "operationId": "advanceReceiptControllerVoidPOST", "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": "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\\Clinical\\Billing\\Controllers\\AdvanceReceiptController@void", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.payments.post" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.payments.post" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advanceReceipt", "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/clinical/patients/{patient}/allergies": { "get": { "tags": [ "Shared" ], "operationId": "patientAllergyControllerIndexGET", "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\\Clinical\\Patients\\Controllers\\PatientAllergyController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "patientAllergyControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Patients\\Controllers\\PatientAllergyController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/allergies/{allergy}": { "delete": { "tags": [ "Shared" ], "operationId": "patientAllergyControllerDestroyDELETE", "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\\Clinical\\Patients\\Controllers\\PatientAllergyController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "allergy", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "patientAllergyControllerUpdatePATCH", "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\\Clinical\\Patients\\Controllers\\PatientAllergyController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "allergy", "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/clinical/patients/{patient}/appointments": { "get": { "tags": [ "Shared" ], "operationId": "patientControllerAppointmentsGET", "summary": "Appointments", "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\\Clinical\\Patients\\Controllers\\PatientController@appointments", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.appointments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.appointments.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/bills": { "get": { "tags": [ "Shared" ], "operationId": "patientControllerBillsGET", "summary": "Bills", "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\\Clinical\\Patients\\Controllers\\PatientController@bills", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.billing.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/contacts": { "get": { "tags": [ "Shared" ], "operationId": "patientContactControllerIndexGET", "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\\Clinical\\Patients\\Controllers\\PatientContactController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "patientContactControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Patients\\Controllers\\PatientContactController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/contacts/{contact}": { "delete": { "tags": [ "Shared" ], "operationId": "patientContactControllerDestroyDELETE", "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\\Clinical\\Patients\\Controllers\\PatientContactController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "patientContactControllerUpdatePATCH", "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\\Clinical\\Patients\\Controllers\\PatientContactController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/documents": { "get": { "tags": [ "Shared" ], "operationId": "patientDocumentControllerIndexGET", "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\\Clinical\\Patients\\Controllers\\PatientDocumentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.documents.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.documents.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/documents/intent": { "post": { "tags": [ "Shared" ], "operationId": "patientDocumentControllerCreateIntentPOST", "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": null, "x-action": "App\\Domains\\Clinical\\Patients\\Controllers\\PatientDocumentController@createIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.documents.upload" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.documents.upload" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/documents/upload": { "post": { "tags": [ "Shared" ], "operationId": "patientDocumentControllerUploadPOST", "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": "clinical.patients.documents.upload", "x-action": "App\\Domains\\Clinical\\Patients\\Controllers\\PatientDocumentController@upload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.documents.upload" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.documents.upload" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/documents/{document}": { "delete": { "tags": [ "Shared" ], "operationId": "patientDocumentControllerDestroyDELETE", "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\\Clinical\\Patients\\Controllers\\PatientDocumentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.documents.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.documents.delete" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "patientDocumentControllerShowGET", "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\\Clinical\\Patients\\Controllers\\PatientDocumentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.documents.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.documents.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/documents/{document}/complete": { "post": { "tags": [ "Shared" ], "operationId": "patientDocumentControllerCompletePOST", "summary": "Complete", "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\\Clinical\\Patients\\Controllers\\PatientDocumentController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.documents.upload" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.documents.upload" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/documents/{document}/download": { "get": { "tags": [ "Shared" ], "operationId": "patientDocumentControllerDownloadGET", "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": null, "x-action": "App\\Domains\\Clinical\\Patients\\Controllers\\PatientDocumentController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.documents.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.documents.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/encounters": { "get": { "tags": [ "Shared" ], "operationId": "patientControllerEncountersGET", "summary": "Encounters", "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\\Clinical\\Patients\\Controllers\\PatientController@encounters", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/histories": { "get": { "tags": [ "Shared" ], "operationId": "patientHistoryControllerIndexGET", "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\\Clinical\\Patients\\Controllers\\PatientHistoryController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "patientHistoryControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Patients\\Controllers\\PatientHistoryController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/histories/{history}": { "delete": { "tags": [ "Shared" ], "operationId": "patientHistoryControllerDestroyDELETE", "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\\Clinical\\Patients\\Controllers\\PatientHistoryController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "history", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "patientHistoryControllerUpdatePATCH", "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\\Clinical\\Patients\\Controllers\\PatientHistoryController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "history", "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/clinical/patients/{patient}/insurances": { "get": { "tags": [ "Shared" ], "operationId": "patientInsuranceControllerIndexGET", "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\\Clinical\\Patients\\Controllers\\PatientInsuranceController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "patientInsuranceControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Patients\\Controllers\\PatientInsuranceController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/insurances/{insurance}": { "delete": { "tags": [ "Shared" ], "operationId": "patientInsuranceControllerDestroyDELETE", "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\\Clinical\\Patients\\Controllers\\PatientInsuranceController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insurance", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "patientInsuranceControllerUpdatePATCH", "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\\Clinical\\Patients\\Controllers\\PatientInsuranceController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view", "permission:clinical.patients.update" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.update", "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insurance", "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/clinical/patients/{patient}/ledger": { "get": { "tags": [ "Shared" ], "operationId": "ledgerControllerIndexGET", "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\\Clinical\\Billing\\Controllers\\LedgerController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.ledger.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.ledger.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/ledger/advances": { "post": { "tags": [ "Shared" ], "operationId": "ledgerControllerReceiveAdvancePOST", "summary": "Receive Advance", "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\\Clinical\\Billing\\Controllers\\LedgerController@receiveAdvance", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.payments.post" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.payments.post" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/ledger/refunds": { "post": { "tags": [ "Shared" ], "operationId": "ledgerControllerRefundCreditPOST", "summary": "Refund Credit", "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\\Clinical\\Billing\\Controllers\\LedgerController@refundCredit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.refunds.post" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.refunds.post" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/merge-history": { "get": { "tags": [ "Shared" ], "operationId": "patientControllerMergeHistoryGET", "summary": "Merge History", "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\\Clinical\\Patients\\Controllers\\PatientController@mergeHistory", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/packages": { "get": { "tags": [ "Shared" ], "operationId": "patientPackageControllerIndexGET", "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\\Clinical\\Billing\\Controllers\\PatientPackageController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patient_packages.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patient_packages.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "patientPackageControllerStorePOST", "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": null, "x-action": "App\\Domains\\Clinical\\Billing\\Controllers\\PatientPackageController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patient_packages.sell" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patient_packages.sell" ], "parameters": [ { "name": "patient", "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/clinical/patients/{patient}/packages/{patientPackage}": { "get": { "tags": [ "Shared" ], "operationId": "patientPackageControllerShowGET", "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\\Clinical\\Billing\\Controllers\\PatientPackageController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patient_packages.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patient_packages.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "patientPackage", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{patient}/packages/{patientPackage}/adjust-balance": { "post": { "tags": [ "Shared" ], "operationId": "patientPackageControllerAdjustBalancePOST", "summary": "Adjust Balance", "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\\Clinical\\Billing\\Controllers\\PatientPackageController@adjustBalance", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patient_packages.adjust" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patient_packages.adjust" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "patientPackage", "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/clinical/patients/{patient}/packages/{patientPackage}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "patientPackageControllerCancelPOST", "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": null, "x-action": "App\\Domains\\Clinical\\Billing\\Controllers\\PatientPackageController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patient_packages.adjust" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patient_packages.adjust" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "patientPackage", "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/clinical/patients/{patient}/packages/{patientPackage}/consume": { "post": { "tags": [ "Shared" ], "operationId": "patientPackageControllerConsumePOST", "summary": "Consume", "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\\Clinical\\Billing\\Controllers\\PatientPackageController@consume", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patient_packages.consume" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patient_packages.consume" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "patientPackage", "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/clinical/patients/{patient}/packages/{patientPackage}/void-consumption/{consumption}": { "post": { "tags": [ "Shared" ], "operationId": "patientPackageControllerVoidConsumptionPOST", "summary": "Void Consumption", "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\\Clinical\\Billing\\Controllers\\PatientPackageController@voidConsumption", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patient_packages.consume" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patient_packages.consume" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "patientPackage", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "consumption", "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/clinical/patients/{patient}/summary": { "get": { "tags": [ "Shared" ], "operationId": "patientControllerSummaryGET", "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": null, "x-action": "App\\Domains\\Clinical\\Patients\\Controllers\\PatientController@summary", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.view" ], "parameters": [ { "name": "patient", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/patients/{sourcePatient}/merge-into/{targetPatient}": { "post": { "tags": [ "Shared" ], "operationId": "patientControllerMergeIntoPOST", "summary": "Merge Into", "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\\Clinical\\Patients\\Controllers\\PatientController@mergeInto", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.patients.merge" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.patients.merge" ], "parameters": [ { "name": "sourcePatient", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "targetPatient", "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/clinical/reception/dashboard": { "get": { "tags": [ "Shared" ], "operationId": "receptionControllerDashboardGET", "summary": "Dashboard", "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\\Clinical\\Reception\\Controllers\\ReceptionController@dashboard", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reception.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reception.view" ] } }, "/api/clinical/reception/encounters/{encounter}/registration": { "patch": { "tags": [ "Shared" ], "operationId": "receptionControllerUpdateRegistrationPATCH", "summary": "Update Registration", "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\\Clinical\\Reception\\Controllers\\ReceptionController@updateRegistration", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reception.register" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reception.register" ], "parameters": [ { "name": "encounter", "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/clinical/reception/queue-counts": { "get": { "tags": [ "Shared" ], "operationId": "receptionControllerQueueCountsGET", "summary": "Queue Counts", "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\\Clinical\\Reception\\Controllers\\ReceptionController@queueCounts", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reception.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reception.view" ] } }, "/api/clinical/reception/register-from-appointment": { "post": { "tags": [ "Shared" ], "operationId": "receptionControllerRegisterFromAppointmentPOST", "summary": "Register From Appointment", "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\\Clinical\\Reception\\Controllers\\ReceptionController@registerFromAppointment", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reception.register" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reception.register" ], "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/clinical/reception/today-flow": { "get": { "tags": [ "Shared" ], "operationId": "receptionControllerTodayFlowGET", "summary": "Today Flow", "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\\Clinical\\Reception\\Controllers\\ReceptionController@todayFlow", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reception.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reception.view" ] } }, "/api/clinical/reception/walk-ins/register": { "post": { "tags": [ "Shared" ], "operationId": "receptionControllerRegisterWalkInPOST", "summary": "Register Walk In", "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\\Clinical\\Reception\\Controllers\\ReceptionController@registerWalkIn", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reception.register" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reception.register" ], "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/clinical/reports/appointments/no-shows": { "get": { "tags": [ "Shared" ], "operationId": "clinicalReportControllerAppointmentNoShowsGET", "summary": "Appointment No Shows", "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\\Clinical\\Reports\\Controllers\\ClinicalReportController@appointmentNoShows", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reports.appointments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reports.appointments.view" ] } }, "/api/clinical/reports/appointments/utilization": { "get": { "tags": [ "Shared" ], "operationId": "clinicalReportControllerAppointmentUtilizationGET", "summary": "Appointment Utilization", "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\\Clinical\\Reports\\Controllers\\ClinicalReportController@appointmentUtilization", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reports.appointments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reports.appointments.view" ] } }, "/api/clinical/reports/billing/collections": { "get": { "tags": [ "Shared" ], "operationId": "clinicalReportControllerBillingCollectionsGET", "summary": "Billing Collections", "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\\Clinical\\Reports\\Controllers\\ClinicalReportController@billingCollections", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reports.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reports.billing.view" ] } }, "/api/clinical/reports/billing/outstanding-balances": { "get": { "tags": [ "Shared" ], "operationId": "clinicalReportControllerOutstandingBalancesGET", "summary": "Outstanding 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": null, "x-action": "App\\Domains\\Clinical\\Reports\\Controllers\\ClinicalReportController@outstandingBalances", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reports.billing.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reports.billing.view" ] } }, "/api/clinical/reports/packages/expiring": { "get": { "tags": [ "Shared" ], "operationId": "clinicalReportControllerExpiringPackagesGET", "summary": "Expiring Packages", "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\\Clinical\\Reports\\Controllers\\ClinicalReportController@expiringPackages", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reports.packages.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reports.packages.view" ] } }, "/api/clinical/reports/packages/sold-vs-consumed": { "get": { "tags": [ "Shared" ], "operationId": "clinicalReportControllerPackagesSoldVsConsumedGET", "summary": "Packages Sold Vs Consumed", "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\\Clinical\\Reports\\Controllers\\ClinicalReportController@packagesSoldVsConsumed", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reports.packages.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reports.packages.view" ] } }, "/api/clinical/reports/providers/workload": { "get": { "tags": [ "Shared" ], "operationId": "clinicalReportControllerProviderWorkloadGET", "summary": "Provider Workload", "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\\Clinical\\Reports\\Controllers\\ClinicalReportController@providerWorkload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.reports.clinical.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.reports.clinical.view" ] } }, "/api/clinical/settings/calendars": { "get": { "tags": [ "Shared" ], "operationId": "calendarControllerIndexGET", "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": "calendars.index", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\CalendarController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "calendarControllerStorePOST", "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": "calendars.store", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\CalendarController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/calendars/{calendar}": { "delete": { "tags": [ "Shared" ], "operationId": "calendarControllerDestroyDELETE", "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": "calendars.destroy", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\CalendarController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "calendarControllerShowGET", "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": "calendars.show", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\CalendarController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ], "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "calendarControllerUpdatePATCH", "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": "calendars.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\CalendarController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "calendar", "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." } } } } }, "put": { "tags": [ "Shared" ], "operationId": "calendarControllerUpdatePUT", "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": "calendars.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\CalendarController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "calendar", "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/clinical/settings/equipment": { "get": { "tags": [ "Shared" ], "operationId": "equipmentResourceControllerIndexGET", "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": "equipment.index", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\EquipmentResourceController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "equipmentResourceControllerStorePOST", "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": "equipment.store", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\EquipmentResourceController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/equipment/{equipment}": { "delete": { "tags": [ "Shared" ], "operationId": "equipmentResourceControllerDestroyDELETE", "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": "equipment.destroy", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\EquipmentResourceController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "equipment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "equipmentResourceControllerShowGET", "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": "equipment.show", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\EquipmentResourceController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ], "parameters": [ { "name": "equipment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "equipmentResourceControllerUpdatePATCH", "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": "equipment.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\EquipmentResourceController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "equipment", "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." } } } } }, "put": { "tags": [ "Shared" ], "operationId": "equipmentResourceControllerUpdatePUT", "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": "equipment.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\EquipmentResourceController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "equipment", "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/clinical/settings/icd10": { "get": { "tags": [ "Shared" ], "operationId": "icd10ControllerIndexGET", "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\\Clinical\\Settings\\Controllers\\Icd10Controller@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] } }, "/api/clinical/settings/icd10/import": { "post": { "tags": [ "Shared" ], "operationId": "icd10ControllerImportPOST", "summary": "Import", "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\\Clinical\\Settings\\Controllers\\Icd10Controller@import", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/icd10/search": { "get": { "tags": [ "Shared" ], "operationId": "icd10ControllerSearchGET", "summary": "Search", "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\\Clinical\\Settings\\Controllers\\Icd10Controller@search", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] } }, "/api/clinical/settings/icd10/{code}": { "delete": { "tags": [ "Shared" ], "operationId": "icd10ControllerDestroyDELETE", "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\\Clinical\\Settings\\Controllers\\Icd10Controller@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "icd10ControllerShowGET", "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\\Clinical\\Settings\\Controllers\\Icd10Controller@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/settings/insurance-categories": { "get": { "tags": [ "Shared" ], "operationId": "insuranceCategoryControllerIndexGET", "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": "insurance-categories.index", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\InsuranceCategoryController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "insuranceCategoryControllerStorePOST", "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": "insurance-categories.store", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\InsuranceCategoryController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/insurance-categories/{insurance_category}": { "delete": { "tags": [ "Shared" ], "operationId": "insuranceCategoryControllerDestroyDELETE", "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": "insurance-categories.destroy", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\InsuranceCategoryController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "insurance_category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "insuranceCategoryControllerShowGET", "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": "insurance-categories.show", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\InsuranceCategoryController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ], "parameters": [ { "name": "insurance_category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "insuranceCategoryControllerUpdatePATCH", "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": "insurance-categories.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\InsuranceCategoryController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "insurance_category", "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." } } } } }, "put": { "tags": [ "Shared" ], "operationId": "insuranceCategoryControllerUpdatePUT", "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": "insurance-categories.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\InsuranceCategoryController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "insurance_category", "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/clinical/settings/note-templates": { "get": { "tags": [ "Shared" ], "operationId": "clinicalNoteTemplateControllerIndexGET", "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\\Clinical\\Settings\\Controllers\\ClinicalNoteTemplateController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "clinicalNoteTemplateControllerStorePOST", "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\\Clinical\\Settings\\Controllers\\ClinicalNoteTemplateController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/note-templates/{noteTemplate}": { "delete": { "tags": [ "Shared" ], "operationId": "clinicalNoteTemplateControllerDestroyDELETE", "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\\Clinical\\Settings\\Controllers\\ClinicalNoteTemplateController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "noteTemplate", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "clinicalNoteTemplateControllerUpdatePATCH", "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\\Clinical\\Settings\\Controllers\\ClinicalNoteTemplateController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "noteTemplate", "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/clinical/settings/rate-charts": { "get": { "tags": [ "Shared" ], "operationId": "rateChartControllerIndexGET", "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\\Clinical\\Settings\\Controllers\\RateChartController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "rateChartControllerStorePOST", "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\\Clinical\\Settings\\Controllers\\RateChartController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/rate-charts/resolve-rate": { "get": { "tags": [ "Shared" ], "operationId": "rateChartControllerResolveRateGET", "summary": "Resolve Rate", "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\\Clinical\\Settings\\Controllers\\RateChartController@resolveRate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ] } }, "/api/clinical/settings/rate-charts/{rateChart}": { "delete": { "tags": [ "Shared" ], "operationId": "rateChartControllerDestroyDELETE", "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\\Clinical\\Settings\\Controllers\\RateChartController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "rateChart", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "rateChartControllerShowGET", "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\\Clinical\\Settings\\Controllers\\RateChartController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "rateChart", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "rateChartControllerUpdatePATCH", "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\\Clinical\\Settings\\Controllers\\RateChartController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "rateChart", "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/clinical/settings/rate-charts/{rateChart}/export": { "get": { "tags": [ "Shared" ], "operationId": "rateChartExportControllerExportGET", "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": null, "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\RateChartExportController@export", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "rateChart", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/settings/rate-charts/{rateChart}/items": { "post": { "tags": [ "Shared" ], "operationId": "rateChartControllerAddItemPOST", "summary": "Add Item", "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\\Clinical\\Settings\\Controllers\\RateChartController@addItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "rateChart", "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/clinical/settings/rate-charts/{rateChart}/items/{itemId}": { "delete": { "tags": [ "Shared" ], "operationId": "rateChartControllerRemoveItemDELETE", "summary": "Remove Item", "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\\Clinical\\Settings\\Controllers\\RateChartController@removeItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "rateChart", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/clinical/settings/rooms": { "get": { "tags": [ "Shared" ], "operationId": "roomControllerIndexGET", "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": "rooms.index", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\RoomController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "roomControllerStorePOST", "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": "rooms.store", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\RoomController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/rooms/{room}": { "delete": { "tags": [ "Shared" ], "operationId": "roomControllerDestroyDELETE", "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": "rooms.destroy", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\RoomController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "room", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "roomControllerShowGET", "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": "rooms.show", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\RoomController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ], "parameters": [ { "name": "room", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "roomControllerUpdatePATCH", "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": "rooms.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\RoomController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "room", "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." } } } } }, "put": { "tags": [ "Shared" ], "operationId": "roomControllerUpdatePUT", "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": "rooms.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\RoomController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "room", "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/clinical/settings/service-groups": { "get": { "tags": [ "Shared" ], "operationId": "serviceGroupControllerIndexGET", "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\\Clinical\\Settings\\Controllers\\ServiceGroupController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "serviceGroupControllerStorePOST", "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\\Clinical\\Settings\\Controllers\\ServiceGroupController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/service-groups/{serviceGroup}": { "delete": { "tags": [ "Shared" ], "operationId": "serviceGroupControllerDestroyDELETE", "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\\Clinical\\Settings\\Controllers\\ServiceGroupController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "serviceGroup", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "serviceGroupControllerUpdatePATCH", "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\\Clinical\\Settings\\Controllers\\ServiceGroupController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "serviceGroup", "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/clinical/settings/services": { "get": { "tags": [ "Shared" ], "operationId": "serviceCatalogControllerIndexGET", "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\\Clinical\\Settings\\Controllers\\ServiceCatalogController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "serviceCatalogControllerStorePOST", "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\\Clinical\\Settings\\Controllers\\ServiceCatalogController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/services/import": { "post": { "tags": [ "Shared" ], "operationId": "serviceCatalogImportControllerImportPOST", "summary": "Import", "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\\Clinical\\Settings\\Controllers\\ServiceCatalogImportController@import", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/services/import/template": { "get": { "tags": [ "Shared" ], "operationId": "serviceCatalogImportControllerTemplateGET", "summary": "Template", "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\\Clinical\\Settings\\Controllers\\ServiceCatalogImportController@template", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] } }, "/api/clinical/settings/services/{service}": { "delete": { "tags": [ "Shared" ], "operationId": "serviceCatalogControllerDestroyDELETE", "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\\Clinical\\Settings\\Controllers\\ServiceCatalogController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "service", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "serviceCatalogControllerShowGET", "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\\Clinical\\Settings\\Controllers\\ServiceCatalogController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ], "parameters": [ { "name": "service", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "serviceCatalogControllerUpdatePATCH", "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\\Clinical\\Settings\\Controllers\\ServiceCatalogController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "service", "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." } } } } }, "put": { "tags": [ "Shared" ], "operationId": "serviceCatalogControllerUpdatePUT", "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\\Clinical\\Settings\\Controllers\\ServiceCatalogController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "service", "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/clinical/settings/specialties": { "get": { "tags": [ "Shared" ], "operationId": "specialtyControllerIndexGET", "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": "specialties.index", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\SpecialtyController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "specialtyControllerStorePOST", "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": "specialties.store", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\SpecialtyController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/specialties/{specialty}": { "delete": { "tags": [ "Shared" ], "operationId": "specialtyControllerDestroyDELETE", "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": "specialties.destroy", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\SpecialtyController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "specialty", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "specialtyControllerShowGET", "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": "specialties.show", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\SpecialtyController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ], "parameters": [ { "name": "specialty", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "specialtyControllerUpdatePATCH", "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": "specialties.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\SpecialtyController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "specialty", "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." } } } } }, "put": { "tags": [ "Shared" ], "operationId": "specialtyControllerUpdatePUT", "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": "specialties.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\SpecialtyController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "specialty", "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/clinical/settings/staff-profiles": { "get": { "tags": [ "Shared" ], "operationId": "staffProfileControllerIndexGET", "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\\Clinical\\Settings\\Controllers\\StaffProfileController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "staffProfileControllerStorePOST", "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\\Clinical\\Settings\\Controllers\\StaffProfileController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/staff-profiles/{clinicalStaffProfile}": { "get": { "tags": [ "Shared" ], "operationId": "staffProfileControllerShowGET", "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\\Clinical\\Settings\\Controllers\\StaffProfileController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "clinicalStaffProfile", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "staffProfileControllerUpdatePATCH", "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\\Clinical\\Settings\\Controllers\\StaffProfileController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "clinicalStaffProfile", "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/clinical/settings/staff-profiles/{clinicalStaffProfile}/availability": { "post": { "tags": [ "Shared" ], "operationId": "staffProfileControllerStoreAvailabilityPOST", "summary": "Store Availability", "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\\Clinical\\Settings\\Controllers\\StaffProfileController@storeAvailability", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "clinicalStaffProfile", "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/clinical/settings/staff-profiles/{clinicalStaffProfile}/availability/{rule}": { "delete": { "tags": [ "Shared" ], "operationId": "staffProfileControllerDestroyAvailabilityDELETE", "summary": "Destroy Availability", "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\\Clinical\\Settings\\Controllers\\StaffProfileController@destroyAvailability", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "clinicalStaffProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rule", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/settings/staff-profiles/{clinicalStaffProfile}/blocked-times": { "post": { "tags": [ "Shared" ], "operationId": "staffProfileControllerStoreBlockedTimePOST", "summary": "Store Blocked Time", "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\\Clinical\\Settings\\Controllers\\StaffProfileController@storeBlockedTime", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "clinicalStaffProfile", "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/clinical/settings/staff-profiles/{clinicalStaffProfile}/blocked-times/{blockedTime}": { "delete": { "tags": [ "Shared" ], "operationId": "staffProfileControllerDestroyBlockedTimeDELETE", "summary": "Destroy Blocked Time", "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\\Clinical\\Settings\\Controllers\\StaffProfileController@destroyBlockedTime", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "clinicalStaffProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "blockedTime", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/clinical/settings/tax-rates": { "get": { "tags": [ "Shared" ], "operationId": "taxRateControllerIndexGET", "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\\Clinical\\Settings\\Controllers\\TaxRateController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "taxRateControllerStorePOST", "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\\Clinical\\Settings\\Controllers\\TaxRateController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/tax-rates/{taxRate}": { "delete": { "tags": [ "Shared" ], "operationId": "taxRateControllerDestroyDELETE", "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\\Clinical\\Settings\\Controllers\\TaxRateController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "taxRate", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "taxRateControllerUpdatePATCH", "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\\Clinical\\Settings\\Controllers\\TaxRateController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "taxRate", "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/clinical/settings/visit-types": { "get": { "tags": [ "Shared" ], "operationId": "visitTypeControllerIndexGET", "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": "visit-types.index", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\VisitTypeController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "visitTypeControllerStorePOST", "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": "visit-types.store", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\VisitTypeController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "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/clinical/settings/visit-types/{visit_type}": { "delete": { "tags": [ "Shared" ], "operationId": "visitTypeControllerDestroyDELETE", "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": "visit-types.destroy", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\VisitTypeController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "visit_type", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "visitTypeControllerShowGET", "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": "visit-types.show", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\VisitTypeController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.view" ], "parameters": [ { "name": "visit_type", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "visitTypeControllerUpdatePATCH", "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": "visit-types.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\VisitTypeController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "visit_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." } } } } }, "put": { "tags": [ "Shared" ], "operationId": "visitTypeControllerUpdatePUT", "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": "visit-types.update", "x-action": "App\\Domains\\Clinical\\Settings\\Controllers\\VisitTypeController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:clinical", "permission:clinical.settings.view", "permission:clinical.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "clinical.settings.manage", "clinical.settings.view" ], "parameters": [ { "name": "visit_type", "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": { "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}/features": { "put": { "tags": [ "Shared" ], "operationId": "companyControllerUpdateFeaturesPUT", "summary": "Update Features", "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@updateFeatures", "x-middleware": [ "api", "auth:sanctum", "company.context" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/custom-gpt/openapi.json": { "get": { "tags": [ "Shared" ], "operationId": "customGptActionsControllerOpenApiGET", "summary": "Open Api", "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": "custom-gpt.openapi", "x-action": "App\\Domains\\Assistant\\Controllers\\CustomGptActionsController@openApi", "x-middleware": [ "api", "throttle:api" ] } }, "/api/custom-gpt/tools": { "get": { "tags": [ "Shared" ], "operationId": "customGptActionsControllerToolsGET", "summary": "Tools", "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": "custom-gpt.tools.index", "x-action": "App\\Domains\\Assistant\\Controllers\\CustomGptActionsController@tools", "x-middleware": [ "api", "custom.gpt.auth", "throttle:api" ] } }, "/api/custom-gpt/tools/{tool}/invoke": { "post": { "tags": [ "Shared" ], "operationId": "customGptActionsControllerInvokePOST", "summary": "Invoke", "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": "custom-gpt.tools.invoke", "x-action": "App\\Domains\\Assistant\\Controllers\\CustomGptActionsController@invoke", "x-middleware": [ "api", "custom.gpt.auth", "throttle:api" ], "parameters": [ { "name": "tool", "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/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", "feature:organization", "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", "feature:organization", "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/export-pdf": { "get": { "tags": [ "Organization" ], "operationId": "departmentManagementControllerExportPdfGET", "summary": "Export Pdf", "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.export-pdf", "x-action": "App\\Domains\\Organization\\Controllers\\DepartmentManagementController@exportPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:organization", "permission:departments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "departments.view" ] } }, "/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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "permission:employees.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "employees.view" ] } }, "/api/employees/export-pdf": { "get": { "tags": [ "Organization" ], "operationId": "employeeManagementControllerExportPdfGET", "summary": "Export Pdf", "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.export-pdf", "x-action": "App\\Domains\\Organization\\Controllers\\EmployeeManagementController@exportPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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/helpdesk/canned-responses": { "get": { "tags": [ "Shared" ], "operationId": "cannedResponseControllerIndexGET", "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": "helpdesk.canned-responses.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CannedResponseController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "cannedResponseControllerStorePOST", "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": "helpdesk.canned-responses.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CannedResponseController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.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/helpdesk/canned-responses/{response}": { "delete": { "tags": [ "Shared" ], "operationId": "cannedResponseControllerDestroyDELETE", "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": "helpdesk.canned-responses.destroy", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CannedResponseController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "response", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "cannedResponseControllerUpdatePUT", "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": "helpdesk.canned-responses.update", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CannedResponseController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "response", "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/helpdesk/categories": { "get": { "tags": [ "Shared" ], "operationId": "categoryControllerIndexGET", "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": "helpdesk.categories.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "categoryControllerStorePOST", "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": "helpdesk.categories.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.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/helpdesk/categories/{category}": { "delete": { "tags": [ "Shared" ], "operationId": "categoryControllerDestroyDELETE", "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": "helpdesk.categories.destroy", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "categoryControllerShowGET", "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": "helpdesk.categories.show", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.view" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "categoryControllerUpdatePUT", "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": "helpdesk.categories.update", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "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/helpdesk/categories/{category}/fields": { "get": { "tags": [ "Shared" ], "operationId": "categoryFieldControllerIndexGET", "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": "helpdesk.categories.fields.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryFieldController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.view" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "categoryFieldControllerStorePOST", "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": "helpdesk.categories.fields.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryFieldController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "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/helpdesk/categories/{category}/fields/{field}": { "delete": { "tags": [ "Shared" ], "operationId": "categoryFieldControllerDestroyDELETE", "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": "helpdesk.categories.fields.destroy", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryFieldController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "field", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "categoryFieldControllerUpdatePUT", "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": "helpdesk.categories.fields.update", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryFieldController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "field", "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/helpdesk/categories/{category}/handlers": { "get": { "tags": [ "Shared" ], "operationId": "categoryHandlerControllerIndexGET", "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": "helpdesk.categories.handlers.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryHandlerController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.view" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "categoryHandlerControllerStorePOST", "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": "helpdesk.categories.handlers.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryHandlerController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "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/helpdesk/categories/{category}/handlers/{employee}": { "delete": { "tags": [ "Shared" ], "operationId": "categoryHandlerControllerDestroyDELETE", "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": "helpdesk.categories.handlers.destroy", "x-action": "App\\Domains\\HelpDesk\\Controllers\\CategoryHandlerController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/helpdesk/categories/{category}/templates": { "get": { "tags": [ "Shared" ], "operationId": "ticketTemplateControllerIndexGET", "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": "helpdesk.categories.templates.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketTemplateController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.view" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "ticketTemplateControllerStorePOST", "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": "helpdesk.categories.templates.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketTemplateController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "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/helpdesk/categories/{category}/templates/{template}": { "delete": { "tags": [ "Shared" ], "operationId": "ticketTemplateControllerDestroyDELETE", "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": "helpdesk.categories.templates.destroy", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketTemplateController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "ticketTemplateControllerUpdatePUT", "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": "helpdesk.categories.templates.update", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketTemplateController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.categories.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.manage" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/helpdesk/dashboard": { "get": { "tags": [ "Shared" ], "operationId": "dashboardControllerOverviewGET", "summary": "Overview", "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": "helpdesk.dashboard.overview", "x-action": "App\\Domains\\HelpDesk\\Controllers\\DashboardController@overview", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.reports.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.reports.view" ] } }, "/api/helpdesk/kb/articles": { "get": { "tags": [ "Shared" ], "operationId": "kbArticleControllerIndexGET", "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": "helpdesk.kb.articles.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\KbArticleController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.kb.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.kb.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "kbArticleControllerStorePOST", "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": "helpdesk.kb.articles.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\KbArticleController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.kb.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.kb.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/helpdesk/kb/articles/{article}": { "get": { "tags": [ "Shared" ], "operationId": "kbArticleControllerShowGET", "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": "helpdesk.kb.articles.show", "x-action": "App\\Domains\\HelpDesk\\Controllers\\KbArticleController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.kb.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.kb.view" ], "parameters": [ { "name": "article", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "kbArticleControllerUpdatePUT", "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": "helpdesk.kb.articles.update", "x-action": "App\\Domains\\HelpDesk\\Controllers\\KbArticleController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.kb.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.kb.manage" ], "parameters": [ { "name": "article", "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/helpdesk/kb/articles/{article}/feedback": { "get": { "tags": [ "Shared" ], "operationId": "kbArticleFeedbackControllerIndexGET", "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": "helpdesk.kb.articles.feedback.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\KbArticleFeedbackController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.kb.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.kb.manage" ], "parameters": [ { "name": "article", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "kbArticleFeedbackControllerUpsertPOST", "summary": "Upsert", "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": "helpdesk.kb.articles.feedback.upsert", "x-action": "App\\Domains\\HelpDesk\\Controllers\\KbArticleFeedbackController@upsert", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.kb.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.kb.view" ], "parameters": [ { "name": "article", "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/helpdesk/kb/articles/{article}/publish": { "post": { "tags": [ "Shared" ], "operationId": "kbArticleControllerPublishPOST", "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": "helpdesk.kb.articles.publish", "x-action": "App\\Domains\\HelpDesk\\Controllers\\KbArticleController@publish", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.kb.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.kb.manage" ], "parameters": [ { "name": "article", "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/helpdesk/kb/articles/{article}/unpublish": { "post": { "tags": [ "Shared" ], "operationId": "kbArticleControllerUnpublishPOST", "summary": "Unpublish", "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": "helpdesk.kb.articles.unpublish", "x-action": "App\\Domains\\HelpDesk\\Controllers\\KbArticleController@unpublish", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.kb.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.kb.manage" ], "parameters": [ { "name": "article", "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/helpdesk/kb/search": { "get": { "tags": [ "Shared" ], "operationId": "kbArticleControllerSearchGET", "summary": "Search", "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": "helpdesk.kb.search", "x-action": "App\\Domains\\HelpDesk\\Controllers\\KbArticleController@search", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.kb.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.kb.view" ] } }, "/api/helpdesk/reports/csat": { "get": { "tags": [ "Shared" ], "operationId": "dashboardControllerCsatCsvGET", "summary": "Csat Csv", "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": "helpdesk.reports.csat", "x-action": "App\\Domains\\HelpDesk\\Controllers\\DashboardController@csatCsv", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.reports.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.reports.view" ] } }, "/api/helpdesk/reports/tickets": { "get": { "tags": [ "Shared" ], "operationId": "dashboardControllerTicketsCsvGET", "summary": "Tickets Csv", "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": "helpdesk.reports.tickets", "x-action": "App\\Domains\\HelpDesk\\Controllers\\DashboardController@ticketsCsv", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.reports.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.reports.view" ] } }, "/api/helpdesk/templates": { "get": { "tags": [ "Shared" ], "operationId": "requesterTemplateControllerIndexGET", "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": "helpdesk.templates.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\RequesterTemplateController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.create|helpdesk.categories.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.categories.view", "helpdesk.tickets.create" ] } }, "/api/helpdesk/tickets": { "get": { "tags": [ "Shared" ], "operationId": "ticketControllerIndexGET", "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": "helpdesk.tickets.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.view_all|helpdesk.tickets.view_own" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.view_all", "helpdesk.tickets.view_own" ] }, "post": { "tags": [ "Shared" ], "operationId": "ticketControllerStorePOST", "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": "helpdesk.tickets.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.create" ], "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/helpdesk/tickets/{ticket}": { "get": { "tags": [ "Shared" ], "operationId": "ticketControllerShowGET", "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": "helpdesk.tickets.show", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.view_all|helpdesk.tickets.view_own" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.view_all", "helpdesk.tickets.view_own" ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "ticketControllerUpdatePUT", "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": "helpdesk.tickets.update", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage|helpdesk.tickets.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.create", "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/approve": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerApprovePOST", "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": "helpdesk.tickets.approve", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/assign": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerAssignPOST", "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": "helpdesk.tickets.assign", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@assign", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerCancelPOST", "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": "helpdesk.tickets.cancel", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/close": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerClosePOST", "summary": "Close", "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": "helpdesk.tickets.close", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@close", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/comments": { "get": { "tags": [ "Shared" ], "operationId": "ticketCommentControllerIndexGET", "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": "helpdesk.tickets.comments.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketCommentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "ticketCommentControllerStorePOST", "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": "helpdesk.tickets.comments.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketCommentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/comments/{comment}/attachments": { "get": { "tags": [ "Shared" ], "operationId": "ticketCommentAttachmentControllerIndexGET", "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": "helpdesk.tickets.comments.attachments.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketCommentAttachmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/helpdesk/tickets/{ticket}/comments/{comment}/attachments/intents": { "post": { "tags": [ "Shared" ], "operationId": "ticketCommentAttachmentControllerCreateIntentPOST", "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": "helpdesk.tickets.comments.attachments.intents.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketCommentAttachmentController@createIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "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/helpdesk/tickets/{ticket}/comments/{comment}/attachments/upload": { "post": { "tags": [ "Shared" ], "operationId": "ticketCommentAttachmentControllerUploadPOST", "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": "helpdesk.tickets.comments.attachments.upload", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketCommentAttachmentController@upload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "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/helpdesk/tickets/{ticket}/comments/{comment}/attachments/{attachment}": { "delete": { "tags": [ "Shared" ], "operationId": "ticketCommentAttachmentControllerDestroyDELETE", "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": "helpdesk.tickets.comments.attachments.destroy", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketCommentAttachmentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "ticketCommentAttachmentControllerShowGET", "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": "helpdesk.tickets.comments.attachments.show", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketCommentAttachmentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/helpdesk/tickets/{ticket}/comments/{comment}/attachments/{attachment}/complete": { "post": { "tags": [ "Shared" ], "operationId": "ticketCommentAttachmentControllerCompletePOST", "summary": "Complete", "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": "helpdesk.tickets.comments.attachments.complete", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketCommentAttachmentController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "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": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/helpdesk/tickets/{ticket}/comments/{comment}/attachments/{attachment}/download": { "get": { "tags": [ "Shared" ], "operationId": "ticketCommentAttachmentControllerDownloadGET", "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": "helpdesk.tickets.comments.attachments.download", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketCommentAttachmentController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/helpdesk/tickets/{ticket}/csat": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerCsatPOST", "summary": "Csat", "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": "helpdesk.tickets.csat", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@csat", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/csat/signed": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerCsatSignedPOST", "summary": "Csat Signed", "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": "helpdesk.tickets.csat.signed", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@csatSigned", "x-middleware": [ "api", "signed:relative" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/merge": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerMergePOST", "summary": "Merge", "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": "helpdesk.tickets.merge", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@merge", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/pause": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerPausePOST", "summary": "Pause", "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": "helpdesk.tickets.pause", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@pause", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/reject": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerRejectPOST", "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": "helpdesk.tickets.reject", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/reopen": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerReopenPOST", "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": "helpdesk.tickets.reopen", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@reopen", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/resolve": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerResolvePOST", "summary": "Resolve", "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": "helpdesk.tickets.resolve", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@resolve", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/resume": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerResumePOST", "summary": "Resume", "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": "helpdesk.tickets.resume", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@resume", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/start": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerStartPOST", "summary": "Start", "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": "helpdesk.tickets.start", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@start", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/take": { "post": { "tags": [ "Shared" ], "operationId": "ticketActionControllerTakePOST", "summary": "Take", "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": "helpdesk.tickets.take", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketActionController@take", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/watchers": { "get": { "tags": [ "Shared" ], "operationId": "ticketWatcherControllerIndexGET", "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": "helpdesk.tickets.watchers.index", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketWatcherController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.view_all|helpdesk.tickets.view_own" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.view_all", "helpdesk.tickets.view_own" ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "ticketWatcherControllerStorePOST", "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": "helpdesk.tickets.watchers.store", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketWatcherController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage|helpdesk.tickets.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.create", "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "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/helpdesk/tickets/{ticket}/watchers/{employee}": { "delete": { "tags": [ "Shared" ], "operationId": "ticketWatcherControllerDestroyDELETE", "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": "helpdesk.tickets.watchers.destroy", "x-action": "App\\Domains\\HelpDesk\\Controllers\\TicketWatcherController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:helpdesk", "permission:helpdesk.tickets.manage|helpdesk.tickets.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "helpdesk.tickets.create", "helpdesk.tickets.manage" ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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/export.csv": { "get": { "tags": [ "Shared" ], "operationId": "attendanceControllerExportCsvGET", "summary": "Export Csv", "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.export.csv", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@exportCsv", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.attendance.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.view" ] } }, "/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", "feature:hr", "permission:hr.attendance.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.attendance.view" ] } }, "/api/hr/attendance/monthly-summary/export-pdf": { "get": { "tags": [ "Shared" ], "operationId": "attendanceControllerExportPdfGET", "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.attendance.monthly-summary.export-pdf", "x-action": "App\\Domains\\Hr\\Controllers\\AttendanceController@exportPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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", "feature:hr" ], "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", "feature:hr" ], "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr" ], "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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}/disburse": { "post": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerDisbursePOST", "summary": "Disburse", "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.disburse", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@disburse", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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}/disbursement-method": { "patch": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerUpdateDisbursementMethodPATCH", "summary": "Update Disbursement Method", "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.disbursement-method", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@updateDisbursementMethod", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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": 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}/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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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}/export-pdf": { "get": { "tags": [ "Shared" ], "operationId": "employeeAdvanceControllerExportPdfGET", "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.advances.export-pdf", "x-action": "App\\Domains\\Hr\\Controllers\\EmployeeAdvanceController@exportPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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" } } ] } }, "/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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "permission:hr.leave.ledger.view.company" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.ledger.view.company" ] } }, "/api/hr/leaves/balances/export-pdf": { "get": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerExportLeaveBalancesPdfGET", "summary": "Export Leave Balances 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.leaves.balances.export-pdf", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@exportLeaveBalancesPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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/export.csv": { "get": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerExportCsvGET", "summary": "Export Csv", "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.export.csv", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@exportCsv", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.leave.view.self|hr.leave.view.team|hr.leave.approve.team|hr.leave.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.approve.team", "hr.leave.finalize", "hr.leave.view.self", "hr.leave.view.team" ] } }, "/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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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}/adjust": { "patch": { "tags": [ "Shared" ], "operationId": "leaveRequestControllerAdjustPATCH", "summary": "Adjust", "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.adjust", "x-action": "App\\Domains\\Hr\\Controllers\\LeaveRequestController@adjust", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.leave.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.leave.manage" ], "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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/periods/{period}/mark-paid": { "post": { "tags": [ "Shared" ], "operationId": "payrollControllerMarkPaidPOST", "summary": "Mark Paid", "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.mark-paid", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@markPaid", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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/periods/{period}/void": { "post": { "tags": [ "Shared" ], "operationId": "payrollControllerVoidPeriodPOST", "summary": "Void 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.void", "x-action": "App\\Domains\\Hr\\Controllers\\PayrollController@voidPeriod", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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/settlements": { "get": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerIndexGET", "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.settlements.index", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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": "finalSettlementControllerStorePOST", "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.settlements.store", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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/settlements/pending": { "get": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerPendingGET", "summary": "Pending", "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.settlements.pending", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@pending", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ] } }, "/api/hr/settlements/preview": { "post": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerPreviewPOST", "summary": "Preview", "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.settlements.preview", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@preview", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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/settlements/{settlement}": { "get": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerShowGET", "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.settlements.show", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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": "settlement", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/settlements/{settlement}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerCancelPOST", "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.settlements.cancel", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "settlement", "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/settlements/{settlement}/disburse": { "post": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerDisbursePOST", "summary": "Disburse", "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.settlements.disburse", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@disburse", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize" ], "parameters": [ { "name": "settlement", "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/settlements/{settlement}/export-pdf": { "get": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerExportPdfGET", "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.settlements.export-pdf", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@exportPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "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": "settlement", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/hr/settlements/{settlement}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerFinalizePOST", "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.settlements.finalize", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@finalize", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize" ], "parameters": [ { "name": "settlement", "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/settlements/{settlement}/line-items": { "post": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerStoreLineItemPOST", "summary": "Store Line Item", "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.settlements.line-items.store", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@storeLineItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "settlement", "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/settlements/{settlement}/line-items/{lineItem}": { "delete": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerDestroyLineItemDELETE", "summary": "Destroy Line Item", "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.settlements.line-items.destroy", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@destroyLineItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "settlement", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lineItem", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerUpdateLineItemPATCH", "summary": "Update Line Item", "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.settlements.line-items.update", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@updateLineItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "settlement", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lineItem", "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/settlements/{settlement}/recompute": { "post": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerRecomputePOST", "summary": "Recompute", "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.settlements.recompute", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@recompute", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.payroll.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.manage" ], "parameters": [ { "name": "settlement", "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/settlements/{settlement}/revert": { "post": { "tags": [ "Shared" ], "operationId": "finalSettlementControllerRevertToDraftPOST", "summary": "Revert To 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": "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.settlements.revert", "x-action": "App\\Domains\\Hr\\Controllers\\FinalSettlementController@revertToDraft", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:hr", "permission:hr.payroll.finalize" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "hr.payroll.finalize" ], "parameters": [ { "name": "settlement", "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/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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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", "feature:hr", "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/performance/analytics": { "get": { "tags": [ "Shared" ], "operationId": "performanceAnalyticsControllerIndexGET", "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": "performance.analytics.index", "x-action": "App\\Domains\\Performance\\Controllers\\PerformanceAnalyticsController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/performance/appraisals/{appraisalId}/development-actions": { "get": { "tags": [ "Shared" ], "operationId": "developmentActionControllerIndexGET", "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": "performance.appraisals.development-actions.index", "x-action": "App\\Domains\\Performance\\Controllers\\DevelopmentActionController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "appraisalId", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "developmentActionControllerStorePOST", "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": "performance.appraisals.development-actions.store", "x-action": "App\\Domains\\Performance\\Controllers\\DevelopmentActionController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "appraisalId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/appraisals/{appraisalId}/development-actions/{actionId}": { "delete": { "tags": [ "Shared" ], "operationId": "developmentActionControllerDestroyDELETE", "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": "performance.appraisals.development-actions.destroy", "x-action": "App\\Domains\\Performance\\Controllers\\DevelopmentActionController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "appraisalId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "actionId", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "developmentActionControllerUpdatePATCH", "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": "performance.appraisals.development-actions.update", "x-action": "App\\Domains\\Performance\\Controllers\\DevelopmentActionController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "appraisalId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "actionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/appraisals/{id}": { "get": { "tags": [ "Shared" ], "operationId": "appraisalControllerShowGET", "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": "performance.appraisals.show", "x-action": "App\\Domains\\Performance\\Controllers\\AppraisalController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/performance/appraisals/{id}/acknowledge": { "post": { "tags": [ "Shared" ], "operationId": "appraisalControllerAcknowledgePOST", "summary": "Acknowledge", "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": "performance.appraisals.acknowledge", "x-action": "App\\Domains\\Performance\\Controllers\\AppraisalController@acknowledge", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/appraisals/{id}/calibration-adjust": { "post": { "tags": [ "Shared" ], "operationId": "calibrationControllerAdjustPOST", "summary": "Adjust", "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": "performance.appraisals.calibration-adjust", "x-action": "App\\Domains\\Performance\\Controllers\\CalibrationController@adjust", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/appraisals/{id}/calibration-adjustments": { "get": { "tags": [ "Shared" ], "operationId": "calibrationControllerIndexGET", "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": "performance.appraisals.calibration-adjustments", "x-action": "App\\Domains\\Performance\\Controllers\\CalibrationController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/performance/appraisals/{id}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "appraisalControllerCancelPOST", "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": "performance.appraisals.cancel", "x-action": "App\\Domains\\Performance\\Controllers\\AppraisalController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/appraisals/{id}/enter-calibration": { "post": { "tags": [ "Shared" ], "operationId": "calibrationControllerEnterCalibrationPOST", "summary": "Enter Calibration", "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": "performance.appraisals.enter-calibration", "x-action": "App\\Domains\\Performance\\Controllers\\CalibrationController@enterCalibration", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/appraisals/{id}/finalize": { "post": { "tags": [ "Shared" ], "operationId": "appraisalControllerFinalizePOST", "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": "performance.appraisals.finalize", "x-action": "App\\Domains\\Performance\\Controllers\\AppraisalController@finalize", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/appraisals/{id}/manager-submit": { "post": { "tags": [ "Shared" ], "operationId": "appraisalControllerManagerSubmitPOST", "summary": "Manager 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": "performance.appraisals.manager-submit", "x-action": "App\\Domains\\Performance\\Controllers\\AppraisalController@managerSubmit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/appraisals/{id}/record": { "get": { "tags": [ "Shared" ], "operationId": "appraisalControllerRecordGET", "summary": "Record", "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": "performance.appraisals.record", "x-action": "App\\Domains\\Performance\\Controllers\\AppraisalController@record", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/performance/appraisals/{id}/self-submit": { "post": { "tags": [ "Shared" ], "operationId": "appraisalControllerSelfSubmitPOST", "summary": "Self 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": "performance.appraisals.self-submit", "x-action": "App\\Domains\\Performance\\Controllers\\AppraisalController@selfSubmit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/cycles": { "get": { "tags": [ "Shared" ], "operationId": "cycleControllerIndexGET", "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": "performance.cycles.index", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "cycleControllerStorePOST", "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": "performance.cycles.store", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "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/performance/cycles/{cycleId}/appraisals": { "get": { "tags": [ "Shared" ], "operationId": "appraisalControllerIndexByCycleGET", "summary": "Index By Cycle", "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": "performance.cycles.appraisals.index", "x-action": "App\\Domains\\Performance\\Controllers\\AppraisalController@indexByCycle", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cycleId", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/performance/cycles/{id}": { "delete": { "tags": [ "Shared" ], "operationId": "cycleControllerDestroyDELETE", "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": "performance.cycles.destroy", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "cycleControllerShowGET", "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": "performance.cycles.show", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "cycleControllerUpdatePATCH", "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": "performance.cycles.update", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/cycles/{id}/advance": { "post": { "tags": [ "Shared" ], "operationId": "cycleControllerAdvancePOST", "summary": "Advance", "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": "performance.cycles.advance", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@advance", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/cycles/{id}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "cycleControllerCancelPOST", "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": "performance.cycles.cancel", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/cycles/{id}/close": { "post": { "tags": [ "Shared" ], "operationId": "cycleControllerClosePOST", "summary": "Close", "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": "performance.cycles.close", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@close", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/cycles/{id}/enter-calibration": { "post": { "tags": [ "Shared" ], "operationId": "cycleControllerEnterCalibrationPOST", "summary": "Enter Calibration", "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": "performance.cycles.enter-calibration", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@enterCalibration", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/cycles/{id}/open": { "post": { "tags": [ "Shared" ], "operationId": "cycleControllerOpenPOST", "summary": "Open", "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": "performance.cycles.open", "x-action": "App\\Domains\\Performance\\Controllers\\CycleController@open", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/employees/{employee}/scorecard": { "get": { "tags": [ "Shared" ], "operationId": "employeeScorecardControllerShowGET", "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": "performance.employees.scorecard.show", "x-action": "App\\Domains\\Performance\\Controllers\\EmployeeScorecardController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/performance/kpis": { "get": { "tags": [ "Shared" ], "operationId": "kpiControllerIndexGET", "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": "performance.kpis.index", "x-action": "App\\Domains\\Performance\\Controllers\\KpiController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "kpiControllerStorePOST", "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": "performance.kpis.store", "x-action": "App\\Domains\\Performance\\Controllers\\KpiController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "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/performance/kpis/{id}": { "delete": { "tags": [ "Shared" ], "operationId": "kpiControllerDestroyDELETE", "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": "performance.kpis.destroy", "x-action": "App\\Domains\\Performance\\Controllers\\KpiController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "kpiControllerShowGET", "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": "performance.kpis.show", "x-action": "App\\Domains\\Performance\\Controllers\\KpiController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "kpiControllerUpdatePATCH", "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": "performance.kpis.update", "x-action": "App\\Domains\\Performance\\Controllers\\KpiController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/kras": { "get": { "tags": [ "Shared" ], "operationId": "kraControllerIndexGET", "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": "performance.kras.index", "x-action": "App\\Domains\\Performance\\Controllers\\KraController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "kraControllerStorePOST", "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": "performance.kras.store", "x-action": "App\\Domains\\Performance\\Controllers\\KraController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "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/performance/kras/{id}": { "delete": { "tags": [ "Shared" ], "operationId": "kraControllerDestroyDELETE", "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": "performance.kras.destroy", "x-action": "App\\Domains\\Performance\\Controllers\\KraController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "kraControllerShowGET", "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": "performance.kras.show", "x-action": "App\\Domains\\Performance\\Controllers\\KraController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "kraControllerUpdatePATCH", "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": "performance.kras.update", "x-action": "App\\Domains\\Performance\\Controllers\\KraController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/manager/inbox-items": { "get": { "tags": [ "Shared" ], "operationId": "managerReviewControllerInboxItemsGET", "summary": "Inbox Items", "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": "performance.manager.inbox-items", "x-action": "App\\Domains\\Performance\\Controllers\\ManagerReviewController@inboxItems", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/performance/manager/reviews": { "get": { "tags": [ "Shared" ], "operationId": "managerReviewControllerReviewsGET", "summary": "Reviews", "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": "performance.manager.reviews", "x-action": "App\\Domains\\Performance\\Controllers\\ManagerReviewController@reviews", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/performance/me": { "get": { "tags": [ "Shared" ], "operationId": "selfServiceControllerMeGET", "summary": "Me", "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": "performance.me", "x-action": "App\\Domains\\Performance\\Controllers\\SelfServiceController@me", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/performance/me/scorecard": { "get": { "tags": [ "Shared" ], "operationId": "selfServiceControllerScorecardGET", "summary": "Scorecard", "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": "performance.me.scorecard", "x-action": "App\\Domains\\Performance\\Controllers\\SelfServiceController@scorecard", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/performance/scorecards": { "get": { "tags": [ "Shared" ], "operationId": "scorecardControllerIndexGET", "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": "performance.scorecards.index", "x-action": "App\\Domains\\Performance\\Controllers\\ScorecardController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "scorecardControllerStorePOST", "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": "performance.scorecards.store", "x-action": "App\\Domains\\Performance\\Controllers\\ScorecardController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "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/performance/scorecards/reconcile": { "post": { "tags": [ "Shared" ], "operationId": "scorecardControllerReconcilePOST", "summary": "Reconcile", "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": "performance.scorecards.reconcile", "x-action": "App\\Domains\\Performance\\Controllers\\ScorecardController@reconcile", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "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/performance/scorecards/{id}": { "delete": { "tags": [ "Shared" ], "operationId": "scorecardControllerDestroyDELETE", "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": "performance.scorecards.destroy", "x-action": "App\\Domains\\Performance\\Controllers\\ScorecardController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "scorecardControllerShowGET", "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": "performance.scorecards.show", "x-action": "App\\Domains\\Performance\\Controllers\\ScorecardController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "scorecardControllerUpdatePATCH", "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": "performance.scorecards.update", "x-action": "App\\Domains\\Performance\\Controllers\\ScorecardController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/scorecards/{id}/kpis": { "post": { "tags": [ "Shared" ], "operationId": "scorecardControllerAddKpiPOST", "summary": "Add Kpi", "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": "performance.scorecards.kpis.add", "x-action": "App\\Domains\\Performance\\Controllers\\ScorecardController@addKpi", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/performance/scorecards/{id}/kpis/{kpiId}": { "delete": { "tags": [ "Shared" ], "operationId": "scorecardControllerRemoveKpiDELETE", "summary": "Remove Kpi", "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": "performance.scorecards.kpis.remove", "x-action": "App\\Domains\\Performance\\Controllers\\ScorecardController@removeKpi", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "kpiId", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/performance/settings": { "get": { "tags": [ "Shared" ], "operationId": "performanceSettingsControllerShowGET", "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": "performance.settings.show", "x-action": "App\\Domains\\Performance\\Controllers\\PerformanceSettingsController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "patch": { "tags": [ "Shared" ], "operationId": "performanceSettingsControllerUpdatePATCH", "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": "performance.settings.update", "x-action": "App\\Domains\\Performance\\Controllers\\PerformanceSettingsController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:performance" ], "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/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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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", "feature:organization", "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/quality/accreditation/evidence-pack": { "get": { "tags": [ "Shared" ], "operationId": "accreditationPackControllerEvidencePackGET", "summary": "Evidence Pack", "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": "quality.accreditation.evidence-pack", "x-action": "App\\Domains\\Quality\\Controllers\\AccreditationPackController@evidencePack", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.analytics.view|quality.kpis.view|quality.kpis.manage|quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.audit.manage", "quality.kpis.manage", "quality.kpis.view" ] } }, "/api/quality/analytics": { "get": { "tags": [ "Shared" ], "operationId": "analyticsControllerIndexGET", "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": "quality.analytics", "x-action": "App\\Domains\\Quality\\Controllers\\AnalyticsController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/audit-programs": { "get": { "tags": [ "Shared" ], "operationId": "auditProgramControllerIndexGET", "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": "quality.audit-programs.index", "x-action": "App\\Domains\\Quality\\Controllers\\AuditProgramController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.audit.view|quality.audit.manage|quality.audit_programs.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage", "quality.audit.view", "quality.audit_programs.manage" ] }, "post": { "tags": [ "Shared" ], "operationId": "auditProgramControllerStorePOST", "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": "quality.audit-programs.store", "x-action": "App\\Domains\\Quality\\Controllers\\AuditProgramController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.audit_programs.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit_programs.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/quality/audit-programs/{program}": { "delete": { "tags": [ "Shared" ], "operationId": "auditProgramControllerDestroyDELETE", "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": "quality.audit-programs.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\AuditProgramController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.audit_programs.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit_programs.manage" ], "parameters": [ { "name": "program", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "auditProgramControllerShowGET", "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": "quality.audit-programs.show", "x-action": "App\\Domains\\Quality\\Controllers\\AuditProgramController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.audit.view|quality.audit.manage|quality.audit_programs.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage", "quality.audit.view", "quality.audit_programs.manage" ], "parameters": [ { "name": "program", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "auditProgramControllerUpdatePUT", "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": "quality.audit-programs.update", "x-action": "App\\Domains\\Quality\\Controllers\\AuditProgramController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.audit_programs.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit_programs.manage" ], "parameters": [ { "name": "program", "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/quality/audit-programs/{program}/activate": { "post": { "tags": [ "Shared" ], "operationId": "auditProgramControllerActivatePOST", "summary": "Activate", "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": "quality.audit-programs.activate", "x-action": "App\\Domains\\Quality\\Controllers\\AuditProgramController@activate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.audit_programs.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit_programs.manage" ], "parameters": [ { "name": "program", "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/quality/audit-programs/{program}/approve": { "post": { "tags": [ "Shared" ], "operationId": "auditProgramControllerApprovePOST", "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": "quality.audit-programs.approve", "x-action": "App\\Domains\\Quality\\Controllers\\AuditProgramController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.audit_programs.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit_programs.manage" ], "parameters": [ { "name": "program", "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/quality/audit-programs/{program}/close": { "post": { "tags": [ "Shared" ], "operationId": "auditProgramControllerClosePOST", "summary": "Close", "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": "quality.audit-programs.close", "x-action": "App\\Domains\\Quality\\Controllers\\AuditProgramController@close", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.audit_programs.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit_programs.manage" ], "parameters": [ { "name": "program", "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/quality/audits": { "get": { "tags": [ "Shared" ], "operationId": "auditControllerIndexGET", "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": "quality.audits.index", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "auditControllerStorePOST", "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": "quality.audits.store", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.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/quality/audits/{audit}": { "get": { "tags": [ "Shared" ], "operationId": "auditControllerShowGET", "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": "quality.audits.show", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "audit", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "auditControllerUpdatePUT", "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": "quality.audits.update", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "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/quality/audits/{audit}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "auditControllerCancelPOST", "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": "quality.audits.cancel", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "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/quality/audits/{audit}/complete": { "post": { "tags": [ "Shared" ], "operationId": "auditControllerCompletePOST", "summary": "Complete", "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": "quality.audits.complete", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "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/quality/audits/{audit}/findings": { "get": { "tags": [ "Shared" ], "operationId": "auditFindingControllerIndexGET", "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": "quality.audits.findings.index", "x-action": "App\\Domains\\Quality\\Controllers\\AuditFindingController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "audit", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "auditFindingControllerStorePOST", "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": "quality.audits.findings.store", "x-action": "App\\Domains\\Quality\\Controllers\\AuditFindingController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "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/quality/audits/{audit}/findings/{finding}": { "put": { "tags": [ "Shared" ], "operationId": "auditFindingControllerUpdatePUT", "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": "quality.audits.findings.update", "x-action": "App\\Domains\\Quality\\Controllers\\AuditFindingController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "finding", "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/quality/audits/{audit}/findings/{finding}/promote-to-ncr": { "post": { "tags": [ "Shared" ], "operationId": "auditFindingControllerPromoteToNcrPOST", "summary": "Promote To Ncr", "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": "quality.audits.findings.promote-to-ncr", "x-action": "App\\Domains\\Quality\\Controllers\\AuditFindingController@promoteToNcr", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "finding", "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/quality/audits/{audit}/start": { "post": { "tags": [ "Shared" ], "operationId": "auditControllerStartPOST", "summary": "Start", "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": "quality.audits.start", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@start", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "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/quality/audits/{audit}/team-members": { "post": { "tags": [ "Shared" ], "operationId": "auditControllerAddTeamMemberPOST", "summary": "Add Team Member", "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": "quality.audits.team-members.store", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@addTeamMember", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "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/quality/audits/{audit}/team-members/{member}": { "delete": { "tags": [ "Shared" ], "operationId": "auditControllerRemoveTeamMemberDELETE", "summary": "Remove Team Member", "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": "quality.audits.team-members.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@removeTeamMember", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "member", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/audits/{audit}/verify-effectiveness": { "post": { "tags": [ "Shared" ], "operationId": "auditControllerVerifyEffectivenessPOST", "summary": "Verify Effectiveness", "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": "quality.audits.verify-effectiveness", "x-action": "App\\Domains\\Quality\\Controllers\\AuditController@verifyEffectiveness", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.audit.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.audit.manage" ], "parameters": [ { "name": "audit", "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/quality/capas": { "get": { "tags": [ "Shared" ], "operationId": "capaControllerIndexGET", "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": "quality.capas.index", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "capaControllerStorePOST", "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": "quality.capas.store", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.create|quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.create", "quality.capa.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/quality/capas/{capa}": { "get": { "tags": [ "Shared" ], "operationId": "capaControllerShowGET", "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": "quality.capas.show", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "capa", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "capaControllerUpdatePUT", "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": "quality.capas.update", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "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/quality/capas/{capa}/actions": { "get": { "tags": [ "Shared" ], "operationId": "capaActionControllerIndexGET", "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": "quality.capas.actions.index", "x-action": "App\\Domains\\Quality\\Controllers\\CapaActionController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "capa", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "capaActionControllerStorePOST", "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": "quality.capas.actions.store", "x-action": "App\\Domains\\Quality\\Controllers\\CapaActionController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "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/quality/capas/{capa}/actions/{action}": { "put": { "tags": [ "Shared" ], "operationId": "capaActionControllerUpdatePUT", "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": "quality.capas.actions.update", "x-action": "App\\Domains\\Quality\\Controllers\\CapaActionController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action", "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/quality/capas/{capa}/approve": { "post": { "tags": [ "Shared" ], "operationId": "capaControllerApprovePOST", "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": "quality.capas.approve", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "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/quality/capas/{capa}/close": { "post": { "tags": [ "Shared" ], "operationId": "capaControllerClosePOST", "summary": "Close", "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": "quality.capas.close", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@close", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "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/quality/capas/{capa}/effectiveness-pending": { "post": { "tags": [ "Shared" ], "operationId": "capaControllerMarkEffectivenessPendingPOST", "summary": "Mark Effectiveness Pending", "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": "quality.capas.effectiveness-pending", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@markEffectivenessPending", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "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/quality/capas/{capa}/reject": { "post": { "tags": [ "Shared" ], "operationId": "capaControllerRejectPOST", "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": "quality.capas.reject", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "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/quality/capas/{capa}/start": { "post": { "tags": [ "Shared" ], "operationId": "capaControllerStartPOST", "summary": "Start", "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": "quality.capas.start", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@start", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "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/quality/capas/{capa}/steps": { "get": { "tags": [ "Shared" ], "operationId": "approvalStepControllerIndexGET", "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": "quality.capas.steps.index", "x-action": "App\\Domains\\Quality\\Controllers\\ApprovalStepController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "capa", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "approvalStepControllerStorePOST", "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": "quality.capas.steps.store", "x-action": "App\\Domains\\Quality\\Controllers\\ApprovalStepController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "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/quality/capas/{capa}/steps/{step}": { "delete": { "tags": [ "Shared" ], "operationId": "approvalStepControllerDestroyDELETE", "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": "quality.capas.steps.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\ApprovalStepController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "approvalStepControllerUpdatePUT", "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": "quality.capas.steps.update", "x-action": "App\\Domains\\Quality\\Controllers\\ApprovalStepController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step", "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/quality/capas/{capa}/steps/{step}/approve": { "post": { "tags": [ "Shared" ], "operationId": "approvalStepControllerApprovePOST", "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": "quality.capas.steps.approve", "x-action": "App\\Domains\\Quality\\Controllers\\ApprovalStepController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step", "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/quality/capas/{capa}/steps/{step}/reject": { "post": { "tags": [ "Shared" ], "operationId": "approvalStepControllerRejectPOST", "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": "quality.capas.steps.reject", "x-action": "App\\Domains\\Quality\\Controllers\\ApprovalStepController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step", "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/quality/capas/{capa}/submit": { "post": { "tags": [ "Shared" ], "operationId": "capaControllerSubmitPOST", "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": "quality.capas.submit", "x-action": "App\\Domains\\Quality\\Controllers\\CapaController@submit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage" ], "parameters": [ { "name": "capa", "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/quality/change-requests": { "get": { "tags": [ "Shared" ], "operationId": "changeRequestControllerIndexGET", "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": "quality.change-requests.index", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerStorePOST", "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": "quality.change-requests.store", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/change-requests/{cr}": { "get": { "tags": [ "Shared" ], "operationId": "changeRequestControllerShowGET", "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": "quality.change-requests.show", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "changeRequestControllerUpdatePUT", "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": "quality.change-requests.update", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/change-requests/{cr}/approve": { "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerApprovePOST", "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": "quality.change-requests.approve", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/change-requests/{cr}/close": { "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerClosePOST", "summary": "Close", "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": "quality.change-requests.close", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@close", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/change-requests/{cr}/impacts": { "get": { "tags": [ "Shared" ], "operationId": "changeRequestControllerIndexImpactsGET", "summary": "Index Impacts", "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": "quality.change-requests.impacts.index", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@indexImpacts", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerStoreImpactPOST", "summary": "Store Impact", "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": "quality.change-requests.impacts.store", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@storeImpact", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/change-requests/{cr}/impacts/{impact}": { "delete": { "tags": [ "Shared" ], "operationId": "changeRequestControllerDestroyImpactDELETE", "summary": "Destroy Impact", "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": "quality.change-requests.impacts.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@destroyImpact", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "impact", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "changeRequestControllerUpdateImpactPUT", "summary": "Update Impact", "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": "quality.change-requests.impacts.update", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@updateImpact", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "impact", "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/quality/change-requests/{cr}/reject": { "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerRejectPOST", "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": "quality.change-requests.reject", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@reject", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/change-requests/{cr}/review": { "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerReviewPOST", "summary": "Review", "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": "quality.change-requests.review", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@review", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/change-requests/{cr}/start-implementation": { "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerStartImplementationPOST", "summary": "Start Implementation", "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": "quality.change-requests.start-implementation", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@startImplementation", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/change-requests/{cr}/steps": { "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerAddStepPOST", "summary": "Add 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": "quality.change-requests.steps.store", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@addStep", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/change-requests/{cr}/steps/{step}": { "put": { "tags": [ "Shared" ], "operationId": "changeRequestControllerUpdateStepPUT", "summary": "Update 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": "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": "quality.change-requests.steps.update", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@updateStep", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step", "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/quality/change-requests/{cr}/submit": { "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerSubmitPOST", "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": "quality.change-requests.submit", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@submit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/change-requests/{cr}/verify": { "post": { "tags": [ "Shared" ], "operationId": "changeRequestControllerVerifyPOST", "summary": "Verify", "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": "quality.change-requests.verify", "x-action": "App\\Domains\\Quality\\Controllers\\ChangeRequestController@verify", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "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/quality/cockpit": { "get": { "tags": [ "Shared" ], "operationId": "qualityCockpitControllerIndexGET", "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": "quality.cockpit", "x-action": "App\\Domains\\Quality\\Controllers\\QualityCockpitController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/comments/{comment}": { "delete": { "tags": [ "Shared" ], "operationId": "qualityCommentControllerDestroyDELETE", "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": "quality.comments.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\QualityCommentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/committee-actions": { "get": { "tags": [ "Shared" ], "operationId": "committeeControllerListActionsGET", "summary": "List Actions", "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": "quality.committee-actions.index", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@listActions", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.view|quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage", "quality.committees.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "committeeControllerStoreActionPOST", "summary": "Store Action", "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": "quality.committee-actions.store", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@storeAction", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.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/quality/committee-actions/{action}": { "put": { "tags": [ "Shared" ], "operationId": "committeeControllerUpdateActionPUT", "summary": "Update Action", "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": "quality.committee-actions.update", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@updateAction", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "action", "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/quality/committees": { "get": { "tags": [ "Shared" ], "operationId": "committeeControllerIndexGET", "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": "quality.committees.index", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.view|quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage", "quality.committees.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "committeeControllerStorePOST", "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": "quality.committees.store", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.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/quality/committees/{committee}": { "delete": { "tags": [ "Shared" ], "operationId": "committeeControllerDestroyDELETE", "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": "quality.committees.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "committeeControllerShowGET", "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": "quality.committees.show", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.view|quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage", "quality.committees.view" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "committeeControllerUpdatePUT", "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": "quality.committees.update", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "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/quality/committees/{committee}/meetings": { "get": { "tags": [ "Shared" ], "operationId": "committeeControllerListMeetingsGET", "summary": "List Meetings", "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": "quality.committees.meetings.index", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@listMeetings", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.view|quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage", "quality.committees.view" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "committeeControllerStoreMeetingPOST", "summary": "Store Meeting", "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": "quality.committees.meetings.store", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@storeMeeting", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "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/quality/committees/{committee}/meetings/{meeting}": { "delete": { "tags": [ "Shared" ], "operationId": "committeeControllerDestroyMeetingDELETE", "summary": "Destroy Meeting", "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": "quality.committees.meetings.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@destroyMeeting", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "committeeControllerShowMeetingGET", "summary": "Show Meeting", "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": "quality.committees.meetings.show", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@showMeeting", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.view|quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage", "quality.committees.view" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "committeeControllerUpdateMeetingPUT", "summary": "Update Meeting", "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": "quality.committees.meetings.update", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@updateMeeting", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "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/quality/committees/{committee}/meetings/{meeting}/approve-minutes": { "post": { "tags": [ "Shared" ], "operationId": "committeeControllerApproveMinutesPOST", "summary": "Approve Minutes", "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": "quality.committees.meetings.approve-minutes", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@approveMinutes", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "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/quality/committees/{committee}/meetings/{meeting}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "committeeControllerCancelMeetingPOST", "summary": "Cancel Meeting", "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": "quality.committees.meetings.cancel", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@cancelMeeting", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "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/quality/committees/{committee}/meetings/{meeting}/decisions": { "get": { "tags": [ "Shared" ], "operationId": "committeeControllerListDecisionsGET", "summary": "List Decisions", "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": "quality.committees.meetings.decisions.index", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@listDecisions", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.view|quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage", "quality.committees.view" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "committeeControllerStoreDecisionPOST", "summary": "Store Decision", "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": "quality.committees.meetings.decisions.store", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@storeDecision", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "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/quality/committees/{committee}/meetings/{meeting}/decisions/{decision}": { "delete": { "tags": [ "Shared" ], "operationId": "committeeControllerDestroyDecisionDELETE", "summary": "Destroy Decision", "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": "quality.committees.meetings.decisions.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@destroyDecision", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "decision", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/committees/{committee}/meetings/{meeting}/guests": { "post": { "tags": [ "Shared" ], "operationId": "committeeControllerAddGuestPOST", "summary": "Add Guest", "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": "quality.committees.meetings.guests.store", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@addGuest", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "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/quality/committees/{committee}/meetings/{meeting}/guests/{guest}": { "delete": { "tags": [ "Shared" ], "operationId": "committeeControllerRemoveGuestDELETE", "summary": "Remove Guest", "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": "quality.committees.meetings.guests.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@removeGuest", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "guest", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "committeeControllerUpdateGuestPATCH", "summary": "Update Guest", "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": "quality.committees.meetings.guests.update", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@updateGuest", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "guest", "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/quality/committees/{committee}/meetings/{meeting}/pdf": { "get": { "tags": [ "Shared" ], "operationId": "committeeControllerDownloadMeetingPdfGET", "summary": "Download Meeting 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": "quality.committees.meetings.pdf", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@downloadMeetingPdf", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/committees/{committee}/meetings/{meeting}/record-attendance": { "post": { "tags": [ "Shared" ], "operationId": "committeeControllerRecordAttendancePOST", "summary": "Record Attendance", "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": "quality.committees.meetings.record-attendance", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@recordAttendance", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "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/quality/committees/{committee}/meetings/{meeting}/start-session": { "post": { "tags": [ "Shared" ], "operationId": "committeeControllerStartSessionPOST", "summary": "Start 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": "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": "quality.committees.meetings.start-session", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@startSession", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "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/quality/committees/{committee}/meetings/{meeting}/submit-minutes": { "post": { "tags": [ "Shared" ], "operationId": "committeeControllerSubmitMinutesPOST", "summary": "Submit Minutes", "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": "quality.committees.meetings.submit-minutes", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@submitMinutes", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meeting", "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/quality/committees/{committee}/members": { "post": { "tags": [ "Shared" ], "operationId": "committeeControllerAddMemberPOST", "summary": "Add Member", "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": "quality.committees.members.store", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@addMember", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "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/quality/committees/{committee}/members/{member}": { "delete": { "tags": [ "Shared" ], "operationId": "committeeControllerRemoveMemberDELETE", "summary": "Remove Member", "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": "quality.committees.members.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@removeMember", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "member", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "committeeControllerUpdateMemberPUT", "summary": "Update Member", "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": "quality.committees.members.update", "x-action": "App\\Domains\\Quality\\Controllers\\CommitteeController@updateMember", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.committees.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.committees.manage" ], "parameters": [ { "name": "committee", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "member", "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/quality/competencies": { "get": { "tags": [ "Shared" ], "operationId": "competencyControllerIndexGET", "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": "quality.competencies.index", "x-action": "App\\Domains\\Quality\\Controllers\\CompetencyController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "competencyControllerStorePOST", "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": "quality.competencies.store", "x-action": "App\\Domains\\Quality\\Controllers\\CompetencyController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/competencies/{competency}": { "delete": { "tags": [ "Shared" ], "operationId": "competencyControllerDestroyDELETE", "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": "quality.competencies.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\CompetencyController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "competency", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "competencyControllerShowGET", "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": "quality.competencies.show", "x-action": "App\\Domains\\Quality\\Controllers\\CompetencyController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "competency", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Shared" ], "operationId": "competencyControllerUpdatePATCH", "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": "quality.competencies.update", "x-action": "App\\Domains\\Quality\\Controllers\\CompetencyController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "competency", "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/quality/competencies/{competency}/assign": { "post": { "tags": [ "Shared" ], "operationId": "competencyControllerAssignPOST", "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": "quality.competencies.assign", "x-action": "App\\Domains\\Quality\\Controllers\\CompetencyController@assign", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "competency", "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/quality/competencies/{competency}/assignments": { "get": { "tags": [ "Shared" ], "operationId": "competencyControllerAssignmentsGET", "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": "quality.competencies.assignments", "x-action": "App\\Domains\\Quality\\Controllers\\CompetencyController@assignments", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "competency", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/complaints": { "get": { "tags": [ "Shared" ], "operationId": "complaintControllerIndexGET", "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": "quality.complaints.index", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "complaintControllerStorePOST", "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": "quality.complaints.store", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.create|quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.create", "quality.complaints.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/quality/complaints/check-duplicate": { "post": { "tags": [ "Shared" ], "operationId": "qualityIntelligenceControllerCheckComplaintDuplicatePOST", "summary": "Check Complaint Duplicate", "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": "quality.complaints.check-duplicate", "x-action": "App\\Domains\\Quality\\Controllers\\QualityIntelligenceController@checkComplaintDuplicate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.view|quality.complaints.manage|quality.complaints.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.create", "quality.complaints.manage", "quality.complaints.view" ], "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/quality/complaints/{complaint}": { "get": { "tags": [ "Shared" ], "operationId": "complaintControllerShowGET", "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": "quality.complaints.show", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "complaint", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "complaintControllerUpdatePUT", "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": "quality.complaints.update", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.manage" ], "parameters": [ { "name": "complaint", "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/quality/complaints/{complaint}/acknowledge": { "post": { "tags": [ "Shared" ], "operationId": "complaintControllerAcknowledgePOST", "summary": "Acknowledge", "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": "quality.complaints.acknowledge", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@acknowledge", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.manage" ], "parameters": [ { "name": "complaint", "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/quality/complaints/{complaint}/close": { "post": { "tags": [ "Shared" ], "operationId": "complaintControllerClosePOST", "summary": "Close", "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": "quality.complaints.close", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@close", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.manage" ], "parameters": [ { "name": "complaint", "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/quality/complaints/{complaint}/investigate": { "post": { "tags": [ "Shared" ], "operationId": "complaintControllerInvestigatePOST", "summary": "Investigate", "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": "quality.complaints.investigate", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@investigate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.manage" ], "parameters": [ { "name": "complaint", "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/quality/complaints/{complaint}/possible-duplicates": { "get": { "tags": [ "Shared" ], "operationId": "qualityIntelligenceControllerPossibleComplaintDuplicatesGET", "summary": "Possible Complaint Duplicates", "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": "quality.complaints.possible-duplicates", "x-action": "App\\Domains\\Quality\\Controllers\\QualityIntelligenceController@possibleComplaintDuplicates", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.view|quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.manage", "quality.complaints.view" ], "parameters": [ { "name": "complaint", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/complaints/{complaint}/promote-to-capa": { "post": { "tags": [ "Shared" ], "operationId": "complaintControllerPromoteToCapaPOST", "summary": "Promote To Capa", "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": "quality.complaints.promote-to-capa", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@promoteToCapa", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.manage" ], "parameters": [ { "name": "complaint", "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/quality/complaints/{complaint}/promote-to-ncr": { "post": { "tags": [ "Shared" ], "operationId": "complaintControllerPromoteToNcrPOST", "summary": "Promote To Ncr", "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": "quality.complaints.promote-to-ncr", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@promoteToNcr", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.manage" ], "parameters": [ { "name": "complaint", "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/quality/complaints/{complaint}/resolve": { "post": { "tags": [ "Shared" ], "operationId": "complaintControllerResolvePOST", "summary": "Resolve", "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": "quality.complaints.resolve", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@resolve", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.manage" ], "parameters": [ { "name": "complaint", "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/quality/complaints/{complaint}/void": { "post": { "tags": [ "Shared" ], "operationId": "complaintControllerVoidPOST", "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": "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": "quality.complaints.void", "x-action": "App\\Domains\\Quality\\Controllers\\ComplaintController@void", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.complaints.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.complaints.manage" ], "parameters": [ { "name": "complaint", "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/quality/copq": { "get": { "tags": [ "Shared" ], "operationId": "copqControllerIndexEntriesGET", "summary": "Index Entries", "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": "quality.copq.index", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@indexEntries", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage|quality.analytics.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.copq.manage" ] }, "post": { "tags": [ "Shared" ], "operationId": "copqControllerStoreEntryPOST", "summary": "Store Entry", "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": "quality.copq.store", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@storeEntry", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.copq.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/quality/copq/{copqEntry}": { "delete": { "tags": [ "Shared" ], "operationId": "copqControllerDestroyEntryDELETE", "summary": "Destroy Entry", "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": "quality.copq.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@destroyEntry", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.copq.manage" ], "parameters": [ { "name": "copqEntry", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "copqControllerShowEntryGET", "summary": "Show Entry", "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": "quality.copq.show", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@showEntry", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage|quality.analytics.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.copq.manage" ], "parameters": [ { "name": "copqEntry", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "copqControllerUpdateEntryPUT", "summary": "Update Entry", "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": "quality.copq.update", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@updateEntry", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.copq.manage" ], "parameters": [ { "name": "copqEntry", "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/quality/dashboard": { "get": { "tags": [ "Shared" ], "operationId": "qualityDashboardControllerIndexGET", "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": "quality.dashboard", "x-action": "App\\Domains\\Quality\\Controllers\\QualityDashboardController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/document-templates": { "get": { "tags": [ "Shared" ], "operationId": "documentTemplateControllerIndexGET", "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": "quality.document-templates.index", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentTemplateController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "documentTemplateControllerStorePOST", "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": "quality.document-templates.store", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentTemplateController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.documents.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.documents.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/quality/document-templates/{template}": { "delete": { "tags": [ "Shared" ], "operationId": "documentTemplateControllerDestroyDELETE", "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": "quality.document-templates.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentTemplateController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.documents.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.documents.manage" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "documentTemplateControllerShowGET", "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": "quality.document-templates.show", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentTemplateController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "documentTemplateControllerUpdatePUT", "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": "quality.document-templates.update", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentTemplateController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.documents.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.documents.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/quality/document-templates/{template}/logo": { "post": { "tags": [ "Shared" ], "operationId": "documentTemplateControllerUploadLogoPOST", "summary": "Upload Logo", "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": "quality.document-templates.logo", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentTemplateController@uploadLogo", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.documents.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.documents.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/quality/document-templates/{template}/set-default": { "post": { "tags": [ "Shared" ], "operationId": "documentTemplateControllerSetDefaultPOST", "summary": "Set Default", "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": "quality.document-templates.set-default", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentTemplateController@setDefault", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.documents.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.documents.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/quality/documents": { "get": { "tags": [ "Shared" ], "operationId": "documentControllerIndexGET", "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": "quality.documents.index", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "documentControllerStorePOST", "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": "quality.documents.store", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/documents/{document}": { "get": { "tags": [ "Shared" ], "operationId": "documentControllerShowGET", "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": "quality.documents.show", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "documentControllerUpdatePUT", "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": "quality.documents.update", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "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/quality/documents/{document}/acknowledgement-rules": { "get": { "tags": [ "Shared" ], "operationId": "documentAcknowledgementControllerIndexGET", "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": "quality.documents.acknowledgement-rules.index", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentAcknowledgementController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "documentAcknowledgementControllerStorePOST", "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": "quality.documents.acknowledgement-rules.store", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentAcknowledgementController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.documents.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.documents.manage" ], "parameters": [ { "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/quality/documents/{document}/acknowledgement-rules/{rule}": { "delete": { "tags": [ "Shared" ], "operationId": "documentAcknowledgementControllerDestroyDELETE", "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": "quality.documents.acknowledgement-rules.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentAcknowledgementController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.documents.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.documents.manage" ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rule", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "documentAcknowledgementControllerUpdatePUT", "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": "quality.documents.acknowledgement-rules.update", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentAcknowledgementController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.documents.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.documents.manage" ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/quality/documents/{document}/obsolete": { "post": { "tags": [ "Shared" ], "operationId": "documentControllerObsoletePOST", "summary": "Obsolete", "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": "quality.documents.obsolete", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentController@obsolete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "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/quality/documents/{document}/versions": { "get": { "tags": [ "Shared" ], "operationId": "documentVersionControllerIndexGET", "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": "quality.documents.versions.index", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "documentVersionControllerStorePOST", "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": "quality.documents.versions.store", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "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/quality/documents/{document}/versions/{version}": { "put": { "tags": [ "Shared" ], "operationId": "documentVersionControllerUpdatePUT", "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": "quality.documents.versions.update", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/quality/documents/{document}/versions/{version}/approve": { "post": { "tags": [ "Shared" ], "operationId": "documentVersionControllerApprovePOST", "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": "quality.documents.versions.approve", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/quality/documents/{document}/versions/{version}/docx-payload": { "get": { "tags": [ "Shared" ], "operationId": "documentVersionControllerDocxPayloadGET", "summary": "Docx Payload", "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": "quality.documents.versions.docx-payload", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@docxPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/documents/{document}/versions/{version}/images": { "post": { "tags": [ "Shared" ], "operationId": "documentVersionControllerUploadImagePOST", "summary": "Upload Image", "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": "quality.documents.versions.images", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@uploadImage", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/quality/documents/{document}/versions/{version}/make-effective": { "post": { "tags": [ "Shared" ], "operationId": "documentVersionControllerMakeEffectivePOST", "summary": "Make Effective", "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": "quality.documents.versions.make-effective", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@makeEffective", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/quality/documents/{document}/versions/{version}/obsolete": { "post": { "tags": [ "Shared" ], "operationId": "documentVersionControllerObsoletePOST", "summary": "Obsolete", "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": "quality.documents.versions.obsolete", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@obsolete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/quality/documents/{document}/versions/{version}/pdf-payload": { "get": { "tags": [ "Shared" ], "operationId": "documentVersionControllerPdfPayloadGET", "summary": "Pdf Payload", "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": "quality.documents.versions.pdf-payload", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@pdfPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/documents/{document}/versions/{version}/review": { "post": { "tags": [ "Shared" ], "operationId": "documentVersionControllerReviewPOST", "summary": "Review", "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": "quality.documents.versions.review", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@review", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/quality/documents/{document}/versions/{version}/submit-review": { "post": { "tags": [ "Shared" ], "operationId": "documentVersionControllerSubmitReviewPOST", "summary": "Submit Review", "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": "quality.documents.versions.submit-review", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@submitReview", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/quality/documents/{document}/versions/{version}/validate-body": { "post": { "tags": [ "Shared" ], "operationId": "documentVersionControllerValidateBodyPOST", "summary": "Validate Body", "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": "quality.documents.versions.validate-body", "x-action": "App\\Domains\\Quality\\Controllers\\DocumentVersionController@validateBody", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/quality/employees/{employee}/competence-summary": { "get": { "tags": [ "Shared" ], "operationId": "competencyControllerEmployeeSummaryGET", "summary": "Employee 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": "quality.employees.competence-summary", "x-action": "App\\Domains\\Quality\\Controllers\\CompetencyController@employeeSummary", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/equipment": { "get": { "tags": [ "Shared" ], "operationId": "equipmentControllerIndexGET", "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": "quality.equipment.index", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "equipmentControllerStorePOST", "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": "quality.equipment.store", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/equipment/{equipment}": { "delete": { "tags": [ "Shared" ], "operationId": "equipmentControllerDestroyDELETE", "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": "quality.equipment.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "equipmentControllerShowGET", "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": "quality.equipment.show", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "equipmentControllerUpdatePUT", "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": "quality.equipment.update", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "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/quality/equipment/{equipment}/calibration": { "post": { "tags": [ "Shared" ], "operationId": "equipmentControllerCalibrationPOST", "summary": "Calibration", "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": "quality.equipment.calibration", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentController@calibration", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "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/quality/equipment/{equipment}/events": { "get": { "tags": [ "Shared" ], "operationId": "equipmentEventControllerIndexGET", "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": "quality.equipment.events.index", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentEventController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "equipmentEventControllerStorePOST", "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": "quality.equipment.events.store", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentEventController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "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/quality/equipment/{equipment}/events/{event}/verify-certificate": { "post": { "tags": [ "Shared" ], "operationId": "equipmentEventControllerVerifyCertificatePOST", "summary": "Verify Certificate", "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": "quality.equipment.events.verify-certificate", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentEventController@verifyCertificate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "event", "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/quality/equipment/{equipment}/lifecycle-pdf": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerEquipmentLifecyclePdfPayloadGET", "summary": "Equipment Lifecycle Pdf Payload", "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": "quality.equipment.lifecycle-pdf", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@equipmentLifecyclePdfPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/equipment/{equipment}/maintenance": { "post": { "tags": [ "Shared" ], "operationId": "equipmentControllerMaintenancePOST", "summary": "Maintenance", "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": "quality.equipment.maintenance", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentController@maintenance", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "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/quality/equipment/{equipment}/out-of-service": { "post": { "tags": [ "Shared" ], "operationId": "equipmentControllerOutOfServicePOST", "summary": "Out Of Service", "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": "quality.equipment.out-of-service", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentController@outOfService", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "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/quality/equipment/{equipment}/ppm-records": { "get": { "tags": [ "Shared" ], "operationId": "ppmRecordControllerIndexGET", "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": "quality.equipment.ppm-records.index", "x-action": "App\\Domains\\Quality\\Controllers\\PpmRecordController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "ppmRecordControllerStorePOST", "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": "quality.equipment.ppm-records.store", "x-action": "App\\Domains\\Quality\\Controllers\\PpmRecordController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "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/quality/equipment/{equipment}/ppm-schedules": { "get": { "tags": [ "Shared" ], "operationId": "ppmScheduleControllerIndexGET", "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": "quality.equipment.ppm-schedules.index", "x-action": "App\\Domains\\Quality\\Controllers\\PpmScheduleController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "ppmScheduleControllerStorePOST", "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": "quality.equipment.ppm-schedules.store", "x-action": "App\\Domains\\Quality\\Controllers\\PpmScheduleController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "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/quality/equipment/{equipment}/return-to-service": { "post": { "tags": [ "Shared" ], "operationId": "equipmentControllerReturnToServicePOST", "summary": "Return To Service", "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": "quality.equipment.return-to-service", "x-action": "App\\Domains\\Quality\\Controllers\\EquipmentController@returnToService", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "equipment", "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/quality/fai": { "get": { "tags": [ "Shared" ], "operationId": "manufacturingControllerIndexFaiGET", "summary": "Index Fai", "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": "quality.manufacturing.fai.index", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@indexFai", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.view|quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage", "quality.manufacturing.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerStoreFaiPOST", "summary": "Store Fai", "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": "quality.manufacturing.fai.store", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@storeFai", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.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/quality/fai/{fai}": { "get": { "tags": [ "Shared" ], "operationId": "manufacturingControllerShowFaiGET", "summary": "Show Fai", "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": "quality.manufacturing.fai.show", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@showFai", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.view|quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage", "quality.manufacturing.view" ], "parameters": [ { "name": "fai", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "manufacturingControllerUpdateFaiPUT", "summary": "Update Fai", "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": "quality.manufacturing.fai.update", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@updateFai", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "fai", "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/quality/fai/{fai}/approve": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerApproveFaiPOST", "summary": "Approve Fai", "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": "quality.manufacturing.fai.approve", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@approveFai", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "fai", "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/quality/fai/{fai}/characteristics": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerStoreCharacteristicPOST", "summary": "Store Characteristic", "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": "quality.manufacturing.fai.characteristics.store", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@storeCharacteristic", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "fai", "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/quality/fai/{fai}/characteristics/{char}": { "delete": { "tags": [ "Shared" ], "operationId": "manufacturingControllerDestroyCharacteristicDELETE", "summary": "Destroy Characteristic", "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": "quality.manufacturing.fai.characteristics.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@destroyCharacteristic", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "fai", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "char", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "manufacturingControllerUpdateCharacteristicPUT", "summary": "Update Characteristic", "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": "quality.manufacturing.fai.characteristics.update", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@updateCharacteristic", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "fai", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "char", "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/quality/fai/{fai}/complete": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerCompleteFaiPOST", "summary": "Complete Fai", "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": "quality.manufacturing.fai.complete", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@completeFai", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "fai", "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/quality/fai/{fai}/reject": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerRejectFaiPOST", "summary": "Reject Fai", "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": "quality.manufacturing.fai.reject", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@rejectFai", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "fai", "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/quality/fai/{fai}/start": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerStartFaiPOST", "summary": "Start Fai", "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": "quality.manufacturing.fai.start", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@startFai", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "fai", "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/quality/history": { "get": { "tags": [ "Shared" ], "operationId": "qualityHistoryControllerIndexGET", "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": "quality.history.index", "x-action": "App\\Domains\\Quality\\Controllers\\QualityHistoryController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/history/by-clause": { "get": { "tags": [ "Shared" ], "operationId": "qualityHistoryControllerByClauseGET", "summary": "By Clause", "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": "quality.history.by-clause", "x-action": "App\\Domains\\Quality\\Controllers\\QualityHistoryController@byClause", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/holds": { "get": { "tags": [ "Shared" ], "operationId": "manufacturingControllerIndexHoldsGET", "summary": "Index Holds", "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": "quality.manufacturing.holds.index", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@indexHolds", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.view|quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage", "quality.manufacturing.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerStoreHoldPOST", "summary": "Store Hold", "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": "quality.manufacturing.holds.store", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@storeHold", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.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/quality/holds/export": { "get": { "tags": [ "Shared" ], "operationId": "manufacturingControllerExportHoldsGET", "summary": "Export Holds", "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": "quality.manufacturing.holds.export", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@exportHolds", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.view|quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage", "quality.manufacturing.view" ] } }, "/api/quality/holds/{hold}": { "get": { "tags": [ "Shared" ], "operationId": "manufacturingControllerShowHoldGET", "summary": "Show Hold", "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": "quality.manufacturing.holds.show", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@showHold", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.view|quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage", "quality.manufacturing.view" ], "parameters": [ { "name": "hold", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "manufacturingControllerUpdateHoldPUT", "summary": "Update Hold", "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": "quality.manufacturing.holds.update", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@updateHold", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "hold", "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/quality/holds/{hold}/disposition": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerDispositionHoldPOST", "summary": "Disposition Hold", "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": "quality.manufacturing.holds.disposition", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@dispositionHold", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "hold", "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/quality/holds/{hold}/move-to-mrb": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerMoveToMrbPOST", "summary": "Move To Mrb", "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": "quality.manufacturing.holds.move-to-mrb", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@moveToMrb", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "hold", "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/quality/holds/{hold}/release": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerReleaseHoldPOST", "summary": "Release Hold", "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": "quality.manufacturing.holds.release", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@releaseHold", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "hold", "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/quality/hse/dashboard": { "get": { "tags": [ "Shared" ], "operationId": "hseControllerDashboardGET", "summary": "Dashboard", "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": "quality.hse.dashboard", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@dashboard", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.view|quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage", "quality.hse.view" ] } }, "/api/quality/hse/incidents": { "get": { "tags": [ "Shared" ], "operationId": "hseControllerIndexIncidentsGET", "summary": "Index Incidents", "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": "quality.hse.incidents.index", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@indexIncidents", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "hseControllerStoreIncidentPOST", "summary": "Store Incident", "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": "quality.hse.incidents.store", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@storeIncident", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.create|quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.create", "quality.hse.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/quality/hse/incidents/export": { "get": { "tags": [ "Shared" ], "operationId": "hseControllerExportIncidentsGET", "summary": "Export Incidents", "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": "quality.hse.incidents.export", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@exportIncidents", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/hse/incidents/{incident}": { "get": { "tags": [ "Shared" ], "operationId": "hseControllerShowIncidentGET", "summary": "Show Incident", "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": "quality.hse.incidents.show", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@showIncident", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.view|quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage", "quality.hse.view" ], "parameters": [ { "name": "incident", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "hseControllerUpdateIncidentPUT", "summary": "Update Incident", "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": "quality.hse.incidents.update", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@updateIncident", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "incident", "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/quality/hse/incidents/{incident}/close": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerCloseIncidentPOST", "summary": "Close Incident", "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": "quality.hse.incidents.close", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@closeIncident", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "incident", "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/quality/hse/incidents/{incident}/escalate-to-capa": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerEscalateIncidentToCapaPOST", "summary": "Escalate Incident To Capa", "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": "quality.hse.incidents.escalate-to-capa", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@escalateIncidentToCapa", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "incident", "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/quality/hse/incidents/{incident}/escalate-to-ncr": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerEscalateIncidentToNcrPOST", "summary": "Escalate Incident To Ncr", "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": "quality.hse.incidents.escalate-to-ncr", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@escalateIncidentToNcr", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "incident", "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/quality/hse/incidents/{incident}/mark-actions-pending": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerMarkActionsPendingPOST", "summary": "Mark Actions Pending", "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": "quality.hse.incidents.mark-actions-pending", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@markActionsPending", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "incident", "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/quality/hse/incidents/{incident}/start-investigation": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerStartInvestigationPOST", "summary": "Start Investigation", "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": "quality.hse.incidents.start-investigation", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@startInvestigation", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "incident", "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/quality/hse/incidents/{incident}/void": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerVoidIncidentPOST", "summary": "Void Incident", "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": "quality.hse.incidents.void", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@voidIncident", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "incident", "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/quality/hse/permits": { "get": { "tags": [ "Shared" ], "operationId": "hseControllerIndexPermitsGET", "summary": "Index Permits", "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": "quality.hse.permits.index", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@indexPermits", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.view|quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage", "quality.hse.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "hseControllerStorePermitPOST", "summary": "Store Permit", "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": "quality.hse.permits.store", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@storePermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.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/quality/hse/permits/export": { "get": { "tags": [ "Shared" ], "operationId": "hseControllerExportPermitsGET", "summary": "Export Permits", "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": "quality.hse.permits.export", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@exportPermits", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/hse/permits/{permit}": { "get": { "tags": [ "Shared" ], "operationId": "hseControllerShowPermitGET", "summary": "Show Permit", "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": "quality.hse.permits.show", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@showPermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.view|quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage", "quality.hse.view" ], "parameters": [ { "name": "permit", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "hseControllerUpdatePermitPUT", "summary": "Update Permit", "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": "quality.hse.permits.update", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@updatePermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "permit", "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/quality/hse/permits/{permit}/activate": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerActivatePermitPOST", "summary": "Activate Permit", "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": "quality.hse.permits.activate", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@activatePermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "permit", "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/quality/hse/permits/{permit}/approve": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerApprovePermitPOST", "summary": "Approve Permit", "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": "quality.hse.permits.approve", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@approvePermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "permit", "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/quality/hse/permits/{permit}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerCancelPermitPOST", "summary": "Cancel Permit", "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": "quality.hse.permits.cancel", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@cancelPermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "permit", "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/quality/hse/permits/{permit}/close": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerClosePermitPOST", "summary": "Close Permit", "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": "quality.hse.permits.close", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@closePermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "permit", "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/quality/hse/permits/{permit}/isolation-points": { "put": { "tags": [ "Shared" ], "operationId": "hseControllerUpdateIsolationPointsPUT", "summary": "Update Isolation Points", "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": "quality.hse.permits.isolation-points", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@updateIsolationPoints", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "permit", "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/quality/hse/permits/{permit}/resume": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerResumePermitPOST", "summary": "Resume Permit", "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": "quality.hse.permits.resume", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@resumePermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "permit", "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/quality/hse/permits/{permit}/submit": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerSubmitPermitPOST", "summary": "Submit Permit", "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": "quality.hse.permits.submit", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@submitPermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "permit", "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/quality/hse/permits/{permit}/suspend": { "post": { "tags": [ "Shared" ], "operationId": "hseControllerSuspendPermitPOST", "summary": "Suspend Permit", "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": "quality.hse.permits.suspend", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@suspendPermit", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "permit", "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/quality/hse/toolbox-talks": { "get": { "tags": [ "Shared" ], "operationId": "hseControllerIndexToolboxTalksGET", "summary": "Index Toolbox Talks", "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": "quality.hse.toolbox-talks.index", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@indexToolboxTalks", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.view|quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage", "quality.hse.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "hseControllerStoreToolboxTalkPOST", "summary": "Store Toolbox Talk", "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": "quality.hse.toolbox-talks.store", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@storeToolboxTalk", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.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/quality/hse/toolbox-talks/{talk}": { "delete": { "tags": [ "Shared" ], "operationId": "hseControllerDestroyToolboxTalkDELETE", "summary": "Destroy Toolbox Talk", "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": "quality.hse.toolbox-talks.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@destroyToolboxTalk", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "talk", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "hseControllerUpdateToolboxTalkPUT", "summary": "Update Toolbox Talk", "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": "quality.hse.toolbox-talks.update", "x-action": "App\\Domains\\Quality\\Controllers\\HseController@updateToolboxTalk", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:hse", "permission:quality.hse.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.hse.manage" ], "parameters": [ { "name": "talk", "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/quality/inspection-templates": { "get": { "tags": [ "Shared" ], "operationId": "inspectionTemplateControllerIndexGET", "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": "quality.inspection-templates.index", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionTemplateController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "inspectionTemplateControllerStorePOST", "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": "quality.inspection-templates.store", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionTemplateController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.inspections.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.inspections.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/quality/inspection-templates/{template}": { "delete": { "tags": [ "Shared" ], "operationId": "inspectionTemplateControllerDestroyDELETE", "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": "quality.inspection-templates.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionTemplateController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.inspections.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.inspections.manage" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "inspectionTemplateControllerShowGET", "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": "quality.inspection-templates.show", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionTemplateController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "inspectionTemplateControllerUpdatePUT", "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": "quality.inspection-templates.update", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionTemplateController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.inspections.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.inspections.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/quality/inspection-templates/{template}/items": { "get": { "tags": [ "Shared" ], "operationId": "inspectionTemplateItemControllerIndexGET", "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": "quality.inspection-templates.items.index", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionTemplateItemController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "inspectionTemplateItemControllerStorePOST", "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": "quality.inspection-templates.items.store", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionTemplateItemController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.inspections.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.inspections.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/quality/inspection-templates/{template}/items/{item}": { "delete": { "tags": [ "Shared" ], "operationId": "inspectionTemplateItemControllerDestroyDELETE", "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": "quality.inspection-templates.items.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionTemplateItemController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.inspections.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.inspections.manage" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "inspectionTemplateItemControllerUpdatePUT", "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": "quality.inspection-templates.items.update", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionTemplateItemController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.inspections.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.inspections.manage" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "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/quality/inspections": { "get": { "tags": [ "Shared" ], "operationId": "inspectionRunControllerIndexGET", "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": "quality.inspections.index", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionRunController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "inspectionRunControllerStorePOST", "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": "quality.inspections.store", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionRunController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.inspections.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.inspections.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/quality/inspections/{run}": { "get": { "tags": [ "Shared" ], "operationId": "inspectionRunControllerShowGET", "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": "quality.inspections.show", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionRunController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "run", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/inspections/{run}/complete": { "post": { "tags": [ "Shared" ], "operationId": "inspectionRunControllerCompletePOST", "summary": "Complete", "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": "quality.inspections.complete", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionRunController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "run", "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/quality/inspections/{run}/respond": { "post": { "tags": [ "Shared" ], "operationId": "inspectionRunControllerRespondPOST", "summary": "Respond", "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": "quality.inspections.respond", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionRunController@respond", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "run", "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/quality/inspections/{run}/start": { "post": { "tags": [ "Shared" ], "operationId": "inspectionRunControllerStartPOST", "summary": "Start", "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": "quality.inspections.start", "x-action": "App\\Domains\\Quality\\Controllers\\InspectionRunController@start", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "run", "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/quality/ipc/cases": { "get": { "tags": [ "Shared" ], "operationId": "ipcControllerIndexCasesGET", "summary": "Index Cases", "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": "quality.ipc.cases.index", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@indexCases", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.view|quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage", "quality.ipc.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "ipcControllerStoreCasePOST", "summary": "Store Case", "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": "quality.ipc.cases.store", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@storeCase", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.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/quality/ipc/cases/export": { "get": { "tags": [ "Shared" ], "operationId": "ipcControllerExportCasesGET", "summary": "Export Cases", "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": "quality.ipc.cases.export", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@exportCases", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/ipc/cases/{case}": { "get": { "tags": [ "Shared" ], "operationId": "ipcControllerShowCaseGET", "summary": "Show Case", "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": "quality.ipc.cases.show", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@showCase", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.view|quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage", "quality.ipc.view" ], "parameters": [ { "name": "case", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "ipcControllerUpdateCasePUT", "summary": "Update Case", "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": "quality.ipc.cases.update", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@updateCase", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "case", "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/quality/ipc/cases/{case}/confirm": { "post": { "tags": [ "Shared" ], "operationId": "ipcControllerConfirmCasePOST", "summary": "Confirm Case", "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": "quality.ipc.cases.confirm", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@confirmCase", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "case", "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/quality/ipc/cases/{case}/resolve": { "post": { "tags": [ "Shared" ], "operationId": "ipcControllerResolveCasePOST", "summary": "Resolve Case", "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": "quality.ipc.cases.resolve", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@resolveCase", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "case", "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/quality/ipc/cases/{case}/rule-out": { "post": { "tags": [ "Shared" ], "operationId": "ipcControllerRuleOutCasePOST", "summary": "Rule Out Case", "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": "quality.ipc.cases.rule-out", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@ruleOutCase", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "case", "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/quality/ipc/dashboard": { "get": { "tags": [ "Shared" ], "operationId": "ipcControllerDashboardGET", "summary": "Dashboard", "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": "quality.ipc.dashboard", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@dashboard", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.view|quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage", "quality.ipc.view" ] } }, "/api/quality/ipc/hand-hygiene": { "post": { "tags": [ "Shared" ], "operationId": "ipcControllerBulkStoreObservationsPOST", "summary": "Bulk Store Observations", "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": "quality.ipc.hand-hygiene.bulk-store", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@bulkStoreObservations", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.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/quality/ipc/hand-hygiene/export": { "get": { "tags": [ "Shared" ], "operationId": "ipcControllerExportObservationsGET", "summary": "Export Observations", "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": "quality.ipc.hand-hygiene.export", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@exportObservations", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/ipc/hand-hygiene/summary": { "get": { "tags": [ "Shared" ], "operationId": "ipcControllerComplianceSummaryGET", "summary": "Compliance 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": "quality.ipc.hand-hygiene.summary", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@complianceSummary", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.view|quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage", "quality.ipc.view" ] } }, "/api/quality/ipc/outbreaks": { "get": { "tags": [ "Shared" ], "operationId": "ipcControllerIndexOutbreaksGET", "summary": "Index Outbreaks", "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": "quality.ipc.outbreaks.index", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@indexOutbreaks", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.view|quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage", "quality.ipc.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "ipcControllerStoreOutbreakPOST", "summary": "Store Outbreak", "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": "quality.ipc.outbreaks.store", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@storeOutbreak", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.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/quality/ipc/outbreaks/export": { "get": { "tags": [ "Shared" ], "operationId": "ipcControllerExportCasesGET", "summary": "Export Cases", "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": "quality.ipc.outbreaks.export", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@exportCases", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/ipc/outbreaks/{outbreak}": { "get": { "tags": [ "Shared" ], "operationId": "ipcControllerShowOutbreakGET", "summary": "Show Outbreak", "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": "quality.ipc.outbreaks.show", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@showOutbreak", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.view|quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage", "quality.ipc.view" ], "parameters": [ { "name": "outbreak", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "ipcControllerUpdateOutbreakPUT", "summary": "Update Outbreak", "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": "quality.ipc.outbreaks.update", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@updateOutbreak", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "outbreak", "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/quality/ipc/outbreaks/{outbreak}/attach-case": { "post": { "tags": [ "Shared" ], "operationId": "ipcControllerAttachCasePOST", "summary": "Attach Case", "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": "quality.ipc.outbreaks.attach-case", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@attachCase", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "outbreak", "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/quality/ipc/outbreaks/{outbreak}/close": { "post": { "tags": [ "Shared" ], "operationId": "ipcControllerCloseOutbreakPOST", "summary": "Close Outbreak", "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": "quality.ipc.outbreaks.close", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@closeOutbreak", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "outbreak", "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/quality/ipc/outbreaks/{outbreak}/declare": { "post": { "tags": [ "Shared" ], "operationId": "ipcControllerDeclareOutbreakPOST", "summary": "Declare Outbreak", "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": "quality.ipc.outbreaks.declare", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@declareOutbreak", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "outbreak", "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/quality/ipc/outbreaks/{outbreak}/detach-case": { "post": { "tags": [ "Shared" ], "operationId": "ipcControllerDetachCasePOST", "summary": "Detach Case", "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": "quality.ipc.outbreaks.detach-case", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@detachCase", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "outbreak", "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/quality/ipc/outbreaks/{outbreak}/mark-controlled": { "post": { "tags": [ "Shared" ], "operationId": "ipcControllerMarkControlledPOST", "summary": "Mark Controlled", "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": "quality.ipc.outbreaks.mark-controlled", "x-action": "App\\Domains\\Quality\\Controllers\\IpcController@markControlled", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.ipc.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ipc.manage" ], "parameters": [ { "name": "outbreak", "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/quality/itps": { "get": { "tags": [ "Shared" ], "operationId": "constructionControllerIndexItpsGET", "summary": "Index Itps", "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": "quality.construction.itps.index", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@indexItps", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.view|quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage", "quality.construction.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "constructionControllerStoreItpPOST", "summary": "Store Itp", "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": "quality.construction.itps.store", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@storeItp", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.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/quality/itps/export": { "get": { "tags": [ "Shared" ], "operationId": "constructionControllerExportItpsGET", "summary": "Export Itps", "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": "quality.construction.itps.export", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@exportItps", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.view|quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage", "quality.construction.view" ] } }, "/api/quality/itps/{itp}": { "get": { "tags": [ "Shared" ], "operationId": "constructionControllerShowItpGET", "summary": "Show Itp", "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": "quality.construction.itps.show", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@showItp", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.view|quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage", "quality.construction.view" ], "parameters": [ { "name": "itp", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "constructionControllerUpdateItpPUT", "summary": "Update Itp", "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": "quality.construction.itps.update", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@updateItp", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "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/quality/itps/{itp}/activate": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerActivateItpPOST", "summary": "Activate Itp", "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": "quality.construction.itps.activate", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@activateItp", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "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/quality/itps/{itp}/approve": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerApproveItpPOST", "summary": "Approve Itp", "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": "quality.construction.itps.approve", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@approveItp", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "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/quality/itps/{itp}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerCancelItpPOST", "summary": "Cancel Itp", "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": "quality.construction.itps.cancel", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@cancelItp", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "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/quality/itps/{itp}/complete": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerCompleteItpPOST", "summary": "Complete Itp", "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": "quality.construction.itps.complete", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@completeItp", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "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/quality/itps/{itp}/handover-payload": { "get": { "tags": [ "Shared" ], "operationId": "constructionControllerHandoverPayloadGET", "summary": "Handover Payload", "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": "quality.construction.itps.handover-payload", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@handoverPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.view|quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage", "quality.construction.view" ], "parameters": [ { "name": "itp", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/itps/{itp}/items": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerStoreItemPOST", "summary": "Store Item", "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": "quality.construction.itp-items.store", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@storeItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "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/quality/itps/{itp}/items/{item}": { "delete": { "tags": [ "Shared" ], "operationId": "constructionControllerDestroyItemDELETE", "summary": "Destroy Item", "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": "quality.construction.itp-items.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@destroyItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "constructionControllerUpdateItemPUT", "summary": "Update Item", "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": "quality.construction.itp-items.update", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@updateItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "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/quality/itps/{itp}/items/{item}/complete": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerCompleteItemPOST", "summary": "Complete Item", "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": "quality.construction.itp-items.complete", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@completeItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "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/quality/itps/{itp}/items/{item}/notify": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerNotifyItemPOST", "summary": "Notify Item", "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": "quality.construction.itp-items.notify", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@notifyItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "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/quality/itps/{itp}/items/{item}/release-hold-point": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerReleaseHoldPointPOST", "summary": "Release Hold Point", "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": "quality.construction.itp-items.release-hold-point", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@releaseHoldPoint", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "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/quality/itps/{itp}/items/{item}/waive": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerWaiveItemPOST", "summary": "Waive Item", "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": "quality.construction.itp-items.waive", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@waiveItem", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "itp", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "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/quality/kpi-actions/{action}": { "patch": { "tags": [ "Shared" ], "operationId": "kpiControllerUpdateActionPATCH", "summary": "Update Action", "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": "quality.kpis.actions.update", "x-action": "App\\Domains\\Quality\\Controllers\\KpiController@updateAction", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.kpis.manage" ], "parameters": [ { "name": "action", "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/quality/kpis": { "get": { "tags": [ "Shared" ], "operationId": "kpiControllerIndexGET", "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": "quality.kpis.index", "x-action": "App\\Domains\\Quality\\Controllers\\KpiController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.view|quality.kpis.manage|quality.analytics.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.kpis.manage", "quality.kpis.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "kpiControllerStorePOST", "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": "quality.kpis.store", "x-action": "App\\Domains\\Quality\\Controllers\\KpiController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.kpis.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/quality/kpis/{kpi}": { "delete": { "tags": [ "Shared" ], "operationId": "kpiControllerDestroyDELETE", "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": "quality.kpis.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\KpiController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.kpis.manage" ], "parameters": [ { "name": "kpi", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "kpiControllerShowGET", "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": "quality.kpis.show", "x-action": "App\\Domains\\Quality\\Controllers\\KpiController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.view|quality.kpis.manage|quality.analytics.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.kpis.manage", "quality.kpis.view" ], "parameters": [ { "name": "kpi", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "kpiControllerUpdatePUT", "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": "quality.kpis.update", "x-action": "App\\Domains\\Quality\\Controllers\\KpiController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.kpis.manage" ], "parameters": [ { "name": "kpi", "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/quality/kpis/{kpi}/actions": { "get": { "tags": [ "Shared" ], "operationId": "kpiControllerActionsGET", "summary": "Actions", "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": "quality.kpis.actions.index", "x-action": "App\\Domains\\Quality\\Controllers\\KpiController@actions", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.view|quality.kpis.manage|quality.analytics.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.kpis.manage", "quality.kpis.view" ], "parameters": [ { "name": "kpi", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/kpis/{kpi}/anomaly": { "get": { "tags": [ "Shared" ], "operationId": "qualityIntelligenceControllerKpiAnomalyGET", "summary": "Kpi Anomaly", "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": "quality.kpis.anomaly", "x-action": "App\\Domains\\Quality\\Controllers\\QualityIntelligenceController@kpiAnomaly", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.view|quality.kpis.manage|quality.analytics.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.kpis.manage", "quality.kpis.view" ], "parameters": [ { "name": "kpi", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/kpis/{kpi}/compute-now": { "post": { "tags": [ "Shared" ], "operationId": "kpiControllerComputeNowPOST", "summary": "Compute Now", "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": "quality.kpis.compute-now", "x-action": "App\\Domains\\Quality\\Controllers\\KpiController@computeNow", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.kpis.manage" ], "parameters": [ { "name": "kpi", "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/quality/kpis/{kpi}/snapshots": { "get": { "tags": [ "Shared" ], "operationId": "kpiControllerSnapshotsGET", "summary": "Snapshots", "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": "quality.kpis.snapshots", "x-action": "App\\Domains\\Quality\\Controllers\\KpiController@snapshots", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.kpis.view|quality.kpis.manage|quality.analytics.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.kpis.manage", "quality.kpis.view" ], "parameters": [ { "name": "kpi", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/management-reviews": { "get": { "tags": [ "Shared" ], "operationId": "managementReviewControllerIndexGET", "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": "quality.management-reviews.index", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "managementReviewControllerStorePOST", "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": "quality.management-reviews.store", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/management-reviews/{review}": { "get": { "tags": [ "Shared" ], "operationId": "managementReviewControllerShowGET", "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": "quality.management-reviews.show", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "review", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "managementReviewControllerUpdatePUT", "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": "quality.management-reviews.update", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/management-reviews/{review}/actions": { "get": { "tags": [ "Shared" ], "operationId": "managementReviewControllerIndexActionsGET", "summary": "Index Actions", "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": "quality.management-reviews.actions.index", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@indexActions", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "review", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "managementReviewControllerStoreActionPOST", "summary": "Store Action", "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": "quality.management-reviews.actions.store", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@storeAction", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/management-reviews/{review}/actions/{action}": { "put": { "tags": [ "Shared" ], "operationId": "managementReviewControllerUpdateActionPUT", "summary": "Update Action", "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": "quality.management-reviews.actions.update", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@updateAction", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "review", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action", "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/quality/management-reviews/{review}/attendees": { "post": { "tags": [ "Shared" ], "operationId": "managementReviewControllerAddAttendeePOST", "summary": "Add Attendee", "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": "quality.management-reviews.attendees.store", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@addAttendee", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/management-reviews/{review}/attendees/{attendee}": { "delete": { "tags": [ "Shared" ], "operationId": "managementReviewControllerRemoveAttendeeDELETE", "summary": "Remove Attendee", "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": "quality.management-reviews.attendees.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@removeAttendee", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "review", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attendee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/management-reviews/{review}/cancel": { "post": { "tags": [ "Shared" ], "operationId": "managementReviewControllerCancelPOST", "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": "quality.management-reviews.cancel", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@cancel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/management-reviews/{review}/complete": { "post": { "tags": [ "Shared" ], "operationId": "managementReviewControllerCompletePOST", "summary": "Complete", "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": "quality.management-reviews.complete", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/management-reviews/{review}/start": { "post": { "tags": [ "Shared" ], "operationId": "managementReviewControllerStartPOST", "summary": "Start", "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": "quality.management-reviews.start", "x-action": "App\\Domains\\Quality\\Controllers\\ManagementReviewController@start", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/my-actions": { "get": { "tags": [ "Shared" ], "operationId": "myActionsControllerIndexGET", "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": "quality.my-actions.index", "x-action": "App\\Domains\\Quality\\Controllers\\MyActionsController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/ncrs": { "get": { "tags": [ "Shared" ], "operationId": "ncrControllerIndexGET", "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": "quality.ncrs.index", "x-action": "App\\Domains\\Quality\\Controllers\\NcrController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "ncrControllerStorePOST", "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": "quality.ncrs.store", "x-action": "App\\Domains\\Quality\\Controllers\\NcrController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.ncr.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ncr.create" ], "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/quality/ncrs/check-duplicate": { "post": { "tags": [ "Shared" ], "operationId": "qualityIntelligenceControllerCheckNcrDuplicatePOST", "summary": "Check Ncr Duplicate", "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": "quality.ncrs.check-duplicate", "x-action": "App\\Domains\\Quality\\Controllers\\QualityIntelligenceController@checkNcrDuplicate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.ncr.view|quality.ncr.manage|quality.ncr.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ncr.create", "quality.ncr.manage", "quality.ncr.view" ], "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/quality/ncrs/{ncr}": { "get": { "tags": [ "Shared" ], "operationId": "ncrControllerShowGET", "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": "quality.ncrs.show", "x-action": "App\\Domains\\Quality\\Controllers\\NcrController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ncr", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "ncrControllerUpdatePUT", "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": "quality.ncrs.update", "x-action": "App\\Domains\\Quality\\Controllers\\NcrController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.ncr.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ncr.manage" ], "parameters": [ { "name": "ncr", "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/quality/ncrs/{ncr}/close": { "post": { "tags": [ "Shared" ], "operationId": "ncrControllerClosePOST", "summary": "Close", "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": "quality.ncrs.close", "x-action": "App\\Domains\\Quality\\Controllers\\NcrController@close", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.ncr.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ncr.manage" ], "parameters": [ { "name": "ncr", "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/quality/ncrs/{ncr}/draft-capa": { "get": { "tags": [ "Shared" ], "operationId": "qualityIntelligenceControllerDraftCapaGET", "summary": "Draft Capa", "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": "quality.ncrs.draft-capa", "x-action": "App\\Domains\\Quality\\Controllers\\QualityIntelligenceController@draftCapa", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.ncr.view|quality.ncr.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ncr.manage", "quality.ncr.view" ], "parameters": [ { "name": "ncr", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/ncrs/{ncr}/possible-duplicates": { "get": { "tags": [ "Shared" ], "operationId": "qualityIntelligenceControllerPossibleNcrDuplicatesGET", "summary": "Possible Ncr Duplicates", "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": "quality.ncrs.possible-duplicates", "x-action": "App\\Domains\\Quality\\Controllers\\QualityIntelligenceController@possibleNcrDuplicates", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.ncr.view|quality.ncr.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ncr.manage", "quality.ncr.view" ], "parameters": [ { "name": "ncr", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/ncrs/{ncr}/similar-root-causes": { "get": { "tags": [ "Shared" ], "operationId": "qualityIntelligenceControllerSimilarRootCausesGET", "summary": "Similar Root Causes", "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": "quality.ncrs.similar-root-causes", "x-action": "App\\Domains\\Quality\\Controllers\\QualityIntelligenceController@similarRootCauses", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.ncr.view|quality.ncr.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ncr.manage", "quality.ncr.view" ], "parameters": [ { "name": "ncr", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/ncrs/{ncr}/void": { "post": { "tags": [ "Shared" ], "operationId": "ncrControllerVoidPOST", "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": "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": "quality.ncrs.void", "x-action": "App\\Domains\\Quality\\Controllers\\NcrController@void", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.ncr.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.ncr.manage" ], "parameters": [ { "name": "ncr", "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/quality/objectives": { "get": { "tags": [ "Shared" ], "operationId": "objectiveControllerIndexGET", "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": "quality.objectives.index", "x-action": "App\\Domains\\Quality\\Controllers\\ObjectiveController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "objectiveControllerStorePOST", "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": "quality.objectives.store", "x-action": "App\\Domains\\Quality\\Controllers\\ObjectiveController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/objectives/{objective}": { "get": { "tags": [ "Shared" ], "operationId": "objectiveControllerShowGET", "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": "quality.objectives.show", "x-action": "App\\Domains\\Quality\\Controllers\\ObjectiveController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "objective", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "objectiveControllerUpdatePUT", "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": "quality.objectives.update", "x-action": "App\\Domains\\Quality\\Controllers\\ObjectiveController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "objective", "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/quality/objectives/{objective}/close-period": { "post": { "tags": [ "Shared" ], "operationId": "objectiveControllerClosePeriodPOST", "summary": "Close 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": "quality.objectives.close-period", "x-action": "App\\Domains\\Quality\\Controllers\\ObjectiveController@closePeriod", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "objective", "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/quality/objectives/{objective}/measurements": { "get": { "tags": [ "Shared" ], "operationId": "objectiveControllerIndexMeasurementsGET", "summary": "Index Measurements", "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": "quality.objectives.measurements.index", "x-action": "App\\Domains\\Quality\\Controllers\\ObjectiveController@indexMeasurements", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "objective", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "objectiveControllerStoreMeasurementPOST", "summary": "Store Measurement", "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": "quality.objectives.measurements.store", "x-action": "App\\Domains\\Quality\\Controllers\\ObjectiveController@storeMeasurement", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "objective", "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/quality/objectives/{objective}/recompute-now": { "post": { "tags": [ "Shared" ], "operationId": "objectiveControllerRecomputeNowPOST", "summary": "Recompute Now", "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": "quality.objectives.recompute-now", "x-action": "App\\Domains\\Quality\\Controllers\\ObjectiveController@recomputeNow", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "objective", "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/quality/org-card": { "get": { "tags": [ "Shared" ], "operationId": "qualityDashboardControllerOrgCardGET", "summary": "Org Card", "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": "quality.org-card", "x-action": "App\\Domains\\Quality\\Controllers\\QualityDashboardController@orgCard", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/ppm-records/{record}": { "get": { "tags": [ "Shared" ], "operationId": "ppmRecordControllerShowGET", "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": "quality.ppm-records.show", "x-action": "App\\Domains\\Quality\\Controllers\\PpmRecordController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "ppmRecordControllerUpdatePUT", "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": "quality.ppm-records.update", "x-action": "App\\Domains\\Quality\\Controllers\\PpmRecordController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "record", "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/quality/ppm-records/{record}/complete": { "post": { "tags": [ "Shared" ], "operationId": "ppmRecordControllerCompletePOST", "summary": "Complete", "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": "quality.ppm-records.complete", "x-action": "App\\Domains\\Quality\\Controllers\\PpmRecordController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "record", "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/quality/ppm-schedules/{schedule}": { "delete": { "tags": [ "Shared" ], "operationId": "ppmScheduleControllerDestroyDELETE", "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": "quality.ppm-schedules.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\PpmScheduleController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "schedule", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "ppmScheduleControllerShowGET", "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": "quality.ppm-schedules.show", "x-action": "App\\Domains\\Quality\\Controllers\\PpmScheduleController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "schedule", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "ppmScheduleControllerUpdatePUT", "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": "quality.ppm-schedules.update", "x-action": "App\\Domains\\Quality\\Controllers\\PpmScheduleController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "schedule", "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/quality/record-tasks": { "post": { "tags": [ "Shared" ], "operationId": "recordTaskControllerStorePOST", "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": "quality.record-tasks.store", "x-action": "App\\Domains\\Quality\\Controllers\\RecordTaskController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/record-tasks/assignable-users": { "get": { "tags": [ "Shared" ], "operationId": "recordTaskControllerAssignableUsersGET", "summary": "Assignable Users", "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": "quality.record-tasks.assignable-users", "x-action": "App\\Domains\\Quality\\Controllers\\RecordTaskController@assignableUsers", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/audit/{audit}/pdf-payload": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerAuditPdfPayloadGET", "summary": "Audit Pdf Payload", "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": "quality.reports.audit.pdf-payload", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@auditPdfPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "audit", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/reports/audits/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportAuditsGET", "summary": "Export Audits", "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": "quality.reports.audits.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportAudits", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/capa/{capa}/pdf-payload": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerCapaPdfPayloadGET", "summary": "Capa Pdf Payload", "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": "quality.reports.capa.pdf-payload", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@capaPdfPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "capa", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/reports/capas/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportCapasGET", "summary": "Export Capas", "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": "quality.reports.capas.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportCapas", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/change-request/{cr}/pdf-payload": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerChangeRequestPdfPayloadGET", "summary": "Change Request Pdf Payload", "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": "quality.reports.change-request.pdf-payload", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@changeRequestPdfPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "cr", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/reports/change-requests/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportChangeRequestsGET", "summary": "Export Change 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": "quality.reports.change-requests.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportChangeRequests", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/complaints/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportComplaintsGET", "summary": "Export Complaints", "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": "quality.reports.complaints.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportComplaints", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/documents/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportDocumentsGET", "summary": "Export Documents", "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": "quality.reports.documents.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportDocuments", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/equipment/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportEquipmentGET", "summary": "Export Equipment", "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": "quality.reports.equipment.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportEquipment", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/inspections/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportInspectionsGET", "summary": "Export Inspections", "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": "quality.reports.inspections.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportInspections", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/management-review/{review}/pdf-payload": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerManagementReviewPdfPayloadGET", "summary": "Management Review Pdf Payload", "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": "quality.reports.management-review.pdf-payload", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@managementReviewPdfPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "review", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/reports/ncr/{ncr}/pdf-payload": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerNcrPdfPayloadGET", "summary": "Ncr Pdf Payload", "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": "quality.reports.ncr.pdf-payload", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@ncrPdfPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "ncr", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/reports/ncrs/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportNcrsGET", "summary": "Export Ncrs", "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": "quality.reports.ncrs.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportNcrs", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/objectives/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportObjectivesGET", "summary": "Export Objectives", "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": "quality.reports.objectives.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportObjectives", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/risk-register/pdf-payload": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerRiskRegisterPdfPayloadGET", "summary": "Risk Register Pdf Payload", "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": "quality.reports.risk-register.pdf-payload", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@riskRegisterPdfPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/risks/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportRisksGET", "summary": "Export Risks", "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": "quality.reports.risks.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportRisks", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/suppliers/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportSuppliersGET", "summary": "Export Suppliers", "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": "quality.reports.suppliers.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportSuppliers", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/training/export": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerExportTrainingGET", "summary": "Export Training", "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": "quality.reports.training.export", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@exportTraining", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/reports/training/{employee}/pdf-payload": { "get": { "tags": [ "Shared" ], "operationId": "qualityReportControllerTrainingPdfPayloadGET", "summary": "Training Pdf Payload", "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": "quality.reports.training.pdf-payload", "x-action": "App\\Domains\\Quality\\Controllers\\QualityReportController@trainingPdfPayload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/risks": { "get": { "tags": [ "Shared" ], "operationId": "riskControllerIndexGET", "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": "quality.risks.index", "x-action": "App\\Domains\\Quality\\Controllers\\RiskController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "riskControllerStorePOST", "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": "quality.risks.store", "x-action": "App\\Domains\\Quality\\Controllers\\RiskController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.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/quality/risks/{risk}": { "get": { "tags": [ "Shared" ], "operationId": "riskControllerShowGET", "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": "quality.risks.show", "x-action": "App\\Domains\\Quality\\Controllers\\RiskController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "risk", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "riskControllerUpdatePUT", "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": "quality.risks.update", "x-action": "App\\Domains\\Quality\\Controllers\\RiskController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.manage" ], "parameters": [ { "name": "risk", "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/quality/risks/{risk}/accept": { "post": { "tags": [ "Shared" ], "operationId": "riskControllerAcceptPOST", "summary": "Accept", "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": "quality.risks.accept", "x-action": "App\\Domains\\Quality\\Controllers\\RiskController@accept", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.manage" ], "parameters": [ { "name": "risk", "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/quality/risks/{risk}/actions": { "get": { "tags": [ "Shared" ], "operationId": "riskActionControllerIndexGET", "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": "quality.risks.actions.index", "x-action": "App\\Domains\\Quality\\Controllers\\RiskActionController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "risk", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "riskActionControllerStorePOST", "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": "quality.risks.actions.store", "x-action": "App\\Domains\\Quality\\Controllers\\RiskActionController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.manage" ], "parameters": [ { "name": "risk", "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/quality/risks/{risk}/actions/{action}": { "put": { "tags": [ "Shared" ], "operationId": "riskActionControllerUpdatePUT", "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": "quality.risks.actions.update", "x-action": "App\\Domains\\Quality\\Controllers\\RiskActionController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.manage" ], "parameters": [ { "name": "risk", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action", "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/quality/risks/{risk}/apply-recommendation": { "post": { "tags": [ "Shared" ], "operationId": "riskWeightingControllerApplyPOST", "summary": "Apply", "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": "quality.risks.apply-recommendation", "x-action": "App\\Domains\\Quality\\Controllers\\RiskWeightingController@apply", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.manage" ], "parameters": [ { "name": "risk", "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/quality/risks/{risk}/close": { "post": { "tags": [ "Shared" ], "operationId": "riskControllerClosePOST", "summary": "Close", "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": "quality.risks.close", "x-action": "App\\Domains\\Quality\\Controllers\\RiskController@close", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.manage" ], "parameters": [ { "name": "risk", "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/quality/risks/{risk}/materialize": { "post": { "tags": [ "Shared" ], "operationId": "riskControllerMaterializePOST", "summary": "Materialize", "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": "quality.risks.materialize", "x-action": "App\\Domains\\Quality\\Controllers\\RiskController@materialize", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.manage" ], "parameters": [ { "name": "risk", "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/quality/risks/{risk}/mitigate": { "post": { "tags": [ "Shared" ], "operationId": "riskControllerMitigatePOST", "summary": "Mitigate", "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": "quality.risks.mitigate", "x-action": "App\\Domains\\Quality\\Controllers\\RiskController@mitigate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.manage" ], "parameters": [ { "name": "risk", "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/quality/risks/{risk}/reassess": { "post": { "tags": [ "Shared" ], "operationId": "riskControllerReassessPOST", "summary": "Reassess", "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": "quality.risks.reassess", "x-action": "App\\Domains\\Quality\\Controllers\\RiskController@reassess", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.risks.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.risks.manage" ], "parameters": [ { "name": "risk", "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/quality/risks/{risk}/recommendations": { "get": { "tags": [ "Shared" ], "operationId": "riskWeightingControllerRecommendationsGET", "summary": "Recommendations", "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": "quality.risks.recommendations", "x-action": "App\\Domains\\Quality\\Controllers\\RiskWeightingController@recommendations", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "risk", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/root-cause-codes": { "get": { "tags": [ "Shared" ], "operationId": "copqControllerIndexRootCauseCodesGET", "summary": "Index Root Cause Codes", "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": "quality.root-cause-codes.index", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@indexRootCauseCodes", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage|quality.ncr.manage|quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage", "quality.copq.manage", "quality.ncr.manage" ] }, "post": { "tags": [ "Shared" ], "operationId": "copqControllerStoreRootCauseCodePOST", "summary": "Store Root Cause Code", "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": "quality.root-cause-codes.store", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@storeRootCauseCode", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.copq.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/quality/root-cause-codes/{rootCauseCode}": { "delete": { "tags": [ "Shared" ], "operationId": "copqControllerDestroyRootCauseCodeDELETE", "summary": "Destroy Root Cause Code", "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": "quality.root-cause-codes.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@destroyRootCauseCode", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.copq.manage" ], "parameters": [ { "name": "rootCauseCode", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "copqControllerShowRootCauseCodeGET", "summary": "Show Root Cause Code", "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": "quality.root-cause-codes.show", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@showRootCauseCode", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage|quality.ncr.manage|quality.capa.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.capa.manage", "quality.copq.manage", "quality.ncr.manage" ], "parameters": [ { "name": "rootCauseCode", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "copqControllerUpdateRootCauseCodePUT", "summary": "Update Root Cause Code", "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": "quality.root-cause-codes.update", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@updateRootCauseCode", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.copq.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.copq.manage" ], "parameters": [ { "name": "rootCauseCode", "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/quality/safety-events": { "get": { "tags": [ "Shared" ], "operationId": "safetyEventControllerIndexGET", "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": "quality.safety-events.index", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerStorePOST", "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": "quality.safety-events.store", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.create|quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.create", "quality.safety_events.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/quality/safety-events/export": { "get": { "tags": [ "Shared" ], "operationId": "safetyEventControllerExportGET", "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": "quality.safety-events.export", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@export", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/safety-events/{event}": { "get": { "tags": [ "Shared" ], "operationId": "safetyEventControllerShowGET", "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": "quality.safety-events.show", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "event", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "safetyEventControllerUpdatePUT", "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": "quality.safety-events.update", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/close": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerClosePOST", "summary": "Close", "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": "quality.safety-events.close", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@close", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/complete-rca": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerCompleteRcaPOST", "summary": "Complete Rca", "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": "quality.safety-events.complete-rca", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@completeRca", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/declare-sentinel": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerDeclareSentinelPOST", "summary": "Declare Sentinel", "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": "quality.safety-events.declare-sentinel", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@declareSentinel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/escalate-to-capa": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerEscalateToCapaPOST", "summary": "Escalate To Capa", "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": "quality.safety-events.escalate-to-capa", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@escalateToCapa", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/escalate-to-ncr": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerEscalateToNcrPOST", "summary": "Escalate To Ncr", "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": "quality.safety-events.escalate-to-ncr", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@escalateToNcr", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/send-to-committee": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerSendToCommitteePOST", "summary": "Send To Committee", "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": "quality.safety-events.send-to-committee", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@sendToCommittee", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/start-investigation": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerStartInvestigationPOST", "summary": "Start Investigation", "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": "quality.safety-events.start-investigation", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@startInvestigation", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/start-rca": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerStartRcaPOST", "summary": "Start Rca", "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": "quality.safety-events.start-rca", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@startRca", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/triage": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerTriagePOST", "summary": "Triage", "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": "quality.safety-events.triage", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@triage", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/safety-events/{event}/void": { "post": { "tags": [ "Shared" ], "operationId": "safetyEventControllerVoidPOST", "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": "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": "quality.safety-events.void", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventController@void", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:healthcare", "permission:quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage" ], "parameters": [ { "name": "event", "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/quality/scorecard": { "get": { "tags": [ "Shared" ], "operationId": "scorecardControllerIndexGET", "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": "quality.scorecard.index", "x-action": "App\\Domains\\Quality\\Controllers\\ScorecardController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.analytics.view|quality.kpis.view|quality.kpis.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.kpis.manage", "quality.kpis.view" ] } }, "/api/quality/scorecard/departments": { "get": { "tags": [ "Shared" ], "operationId": "scorecardControllerDepartmentsGET", "summary": "Departments", "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": "quality.scorecard.departments", "x-action": "App\\Domains\\Quality\\Controllers\\ScorecardController@departments", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.analytics.view|quality.kpis.view|quality.kpis.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.analytics.view", "quality.kpis.manage", "quality.kpis.view" ] } }, "/api/quality/settings/complaint-categories": { "get": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerComplaintCategoriesGET", "summary": "Complaint Categories", "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": "quality.settings.complaint-categories.index", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@complaintCategories", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerStoreComplaintCategoryPOST", "summary": "Store Complaint Category", "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": "quality.settings.complaint-categories.store", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@storeComplaintCategory", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.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/quality/settings/complaint-categories/{category}": { "delete": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerDeleteComplaintCategoryDELETE", "summary": "Delete Complaint Category", "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": "quality.settings.complaint-categories.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@deleteComplaintCategory", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerUpdateComplaintCategoryPUT", "summary": "Update Complaint Category", "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": "quality.settings.complaint-categories.update", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@updateComplaintCategory", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage" ], "parameters": [ { "name": "category", "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/quality/settings/complaints-label": { "get": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerGetComplaintsLabelGET", "summary": "Get Complaints Label", "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": "quality.settings.complaints-label.show", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@getComplaintsLabel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "put": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerUpdateComplaintsLabelPUT", "summary": "Update Complaints Label", "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": "quality.settings.complaints-label.update", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@updateComplaintsLabel", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.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/quality/settings/copq-prompt": { "patch": { "tags": [ "Shared" ], "operationId": "copqControllerCopqPromptSettingPATCH", "summary": "Copq Prompt Setting", "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": "quality.settings.copq-prompt", "x-action": "App\\Domains\\Quality\\Controllers\\CopqController@copqPromptSetting", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.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/quality/settings/modules": { "get": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerGetModulesGET", "summary": "Get Modules", "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": "quality.settings.modules.show", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@getModules", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "patch": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerUpdateModulesPATCH", "summary": "Update Modules", "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": "quality.settings.modules.update", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@updateModules", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.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/quality/settings/ncr-categories": { "get": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerNcrCategoriesGET", "summary": "Ncr Categories", "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": "quality.settings.ncr-categories.index", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@ncrCategories", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerStoreNcrCategoryPOST", "summary": "Store Ncr Category", "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": "quality.settings.ncr-categories.store", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@storeNcrCategory", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.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/quality/settings/ncr-categories/{category}": { "delete": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerDeleteNcrCategoryDELETE", "summary": "Delete Ncr Category", "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": "quality.settings.ncr-categories.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@deleteNcrCategory", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "qualitySettingsControllerUpdateNcrCategoryPUT", "summary": "Update Ncr Category", "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": "quality.settings.ncr-categories.update", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySettingsController@updateNcrCategory", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage" ], "parameters": [ { "name": "category", "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/quality/settings/safety-event-categories": { "get": { "tags": [ "Shared" ], "operationId": "safetyEventCategoryControllerIndexGET", "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": "quality.settings.safety-event-categories.index", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventCategoryController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage|quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage", "quality.settings.manage" ] }, "post": { "tags": [ "Shared" ], "operationId": "safetyEventCategoryControllerStorePOST", "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": "quality.settings.safety-event-categories.store", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventCategoryController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage|quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage", "quality.settings.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/quality/settings/safety-event-categories/{category}": { "delete": { "tags": [ "Shared" ], "operationId": "safetyEventCategoryControllerDestroyDELETE", "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": "quality.settings.safety-event-categories.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventCategoryController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage|quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage", "quality.settings.manage" ], "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "safetyEventCategoryControllerUpdatePUT", "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": "quality.settings.safety-event-categories.update", "x-action": "App\\Domains\\Quality\\Controllers\\SafetyEventCategoryController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage|quality.safety_events.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.safety_events.manage", "quality.settings.manage" ], "parameters": [ { "name": "category", "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/quality/settings/signature-slots": { "get": { "tags": [ "Shared" ], "operationId": "signatureSlotControllerIndexGET", "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": "quality.settings.signature-slots.index", "x-action": "App\\Domains\\Quality\\Controllers\\SignatureSlotController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "signatureSlotControllerStorePOST", "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": "quality.settings.signature-slots.store", "x-action": "App\\Domains\\Quality\\Controllers\\SignatureSlotController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/settings/signature-slots/{slot}": { "delete": { "tags": [ "Shared" ], "operationId": "signatureSlotControllerDestroyDELETE", "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": "quality.settings.signature-slots.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\SignatureSlotController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "slot", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "signatureSlotControllerUpdatePUT", "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": "quality.settings.signature-slots.update", "x-action": "App\\Domains\\Quality\\Controllers\\SignatureSlotController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "slot", "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/quality/settings/signature-slots/{slot}/image": { "post": { "tags": [ "Shared" ], "operationId": "signatureSlotControllerUploadImagePOST", "summary": "Upload Image", "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": "quality.settings.signature-slots.upload-image", "x-action": "App\\Domains\\Quality\\Controllers\\SignatureSlotController@uploadImage", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "slot", "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/quality/settings/sla-policies": { "get": { "tags": [ "Shared" ], "operationId": "slaPolicyControllerIndexGET", "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": "quality.settings.sla-policies.index", "x-action": "App\\Domains\\Quality\\Controllers\\SlaPolicyController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage" ] }, "post": { "tags": [ "Shared" ], "operationId": "slaPolicyControllerStorePOST", "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": "quality.settings.sla-policies.store", "x-action": "App\\Domains\\Quality\\Controllers\\SlaPolicyController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.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/quality/settings/sla-policies/{policy}": { "delete": { "tags": [ "Shared" ], "operationId": "slaPolicyControllerDestroyDELETE", "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": "quality.settings.sla-policies.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\SlaPolicyController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage" ], "parameters": [ { "name": "policy", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "slaPolicyControllerShowGET", "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": "quality.settings.sla-policies.show", "x-action": "App\\Domains\\Quality\\Controllers\\SlaPolicyController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage" ], "parameters": [ { "name": "policy", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "slaPolicyControllerUpdatePUT", "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": "quality.settings.sla-policies.update", "x-action": "App\\Domains\\Quality\\Controllers\\SlaPolicyController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage" ], "parameters": [ { "name": "policy", "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/quality/signatures": { "get": { "tags": [ "Shared" ], "operationId": "qualitySignatureControllerIndexGET", "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": "quality.signatures.index", "x-action": "App\\Domains\\Quality\\Controllers\\QualitySignatureController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/snags": { "get": { "tags": [ "Shared" ], "operationId": "constructionControllerIndexSnagsGET", "summary": "Index Snags", "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": "quality.construction.snags.index", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@indexSnags", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.view|quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage", "quality.construction.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "constructionControllerStoreSnagPOST", "summary": "Store Snag", "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": "quality.construction.snags.store", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@storeSnag", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.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/quality/snags/bulk": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerBulkStoreSnagsPOST", "summary": "Bulk Store Snags", "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": "quality.construction.snags.bulk-store", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@bulkStoreSnags", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.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/quality/snags/export": { "get": { "tags": [ "Shared" ], "operationId": "constructionControllerExportSnagsGET", "summary": "Export Snags", "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": "quality.construction.snags.export", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@exportSnags", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.view|quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage", "quality.construction.view" ] } }, "/api/quality/snags/{snag}": { "get": { "tags": [ "Shared" ], "operationId": "constructionControllerShowSnagGET", "summary": "Show Snag", "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": "quality.construction.snags.show", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@showSnag", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.view|quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage", "quality.construction.view" ], "parameters": [ { "name": "snag", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "constructionControllerUpdateSnagPUT", "summary": "Update Snag", "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": "quality.construction.snags.update", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@updateSnag", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "snag", "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/quality/snags/{snag}/close": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerCloseSnagPOST", "summary": "Close Snag", "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": "quality.construction.snags.close", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@closeSnag", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "snag", "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/quality/snags/{snag}/escalate-to-ncr": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerEscalateSnagToNcrPOST", "summary": "Escalate Snag To Ncr", "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": "quality.construction.snags.escalate-to-ncr", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@escalateSnagToNcr", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "snag", "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/quality/snags/{snag}/mark-in-progress": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerMarkSnagInProgressPOST", "summary": "Mark Snag In Progress", "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": "quality.construction.snags.mark-in-progress", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@markSnagInProgress", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "snag", "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/quality/snags/{snag}/submit-for-review": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerSubmitSnagForReviewPOST", "summary": "Submit Snag For Review", "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": "quality.construction.snags.submit-for-review", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@submitSnagForReview", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "snag", "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/quality/snags/{snag}/void": { "post": { "tags": [ "Shared" ], "operationId": "constructionControllerVoidSnagPOST", "summary": "Void Snag", "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": "quality.construction.snags.void", "x-action": "App\\Domains\\Quality\\Controllers\\ConstructionController@voidSnag", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:construction", "permission:quality.construction.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.construction.manage" ], "parameters": [ { "name": "snag", "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/quality/spc/charts": { "get": { "tags": [ "Shared" ], "operationId": "manufacturingControllerIndexChartsGET", "summary": "Index Charts", "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": "quality.manufacturing.spc.index", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@indexCharts", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.view|quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage", "quality.manufacturing.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerStoreChartPOST", "summary": "Store Chart", "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": "quality.manufacturing.spc.store", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@storeChart", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.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/quality/spc/charts/{chart}": { "get": { "tags": [ "Shared" ], "operationId": "manufacturingControllerShowChartGET", "summary": "Show Chart", "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": "quality.manufacturing.spc.show", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@showChart", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.view|quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage", "quality.manufacturing.view" ], "parameters": [ { "name": "chart", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "manufacturingControllerUpdateChartPUT", "summary": "Update Chart", "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": "quality.manufacturing.spc.update", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@updateChart", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "chart", "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/quality/spc/charts/{chart}/recalculate-limits": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerRecalculateLimitsPOST", "summary": "Recalculate Limits", "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": "quality.manufacturing.spc.recalculate-limits", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@recalculateLimits", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "chart", "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/quality/spc/charts/{chart}/samples": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerStoreSamplePOST", "summary": "Store Sample", "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": "quality.manufacturing.spc.samples.store", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@storeSample", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "chart", "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/quality/spc/charts/{chart}/samples/{sample}/create-ncr": { "post": { "tags": [ "Shared" ], "operationId": "manufacturingControllerCreateNcrFromViolationPOST", "summary": "Create Ncr From Violation", "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": "quality.manufacturing.spc.samples.create-ncr", "x-action": "App\\Domains\\Quality\\Controllers\\ManufacturingController@createNcrFromViolation", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "quality.module:manufacturing", "permission:quality.manufacturing.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.manufacturing.manage" ], "parameters": [ { "name": "chart", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sample", "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/quality/standard-templates": { "get": { "tags": [ "Shared" ], "operationId": "qualityStandardControllerTemplatesGET", "summary": "Templates", "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": "quality.standards.templates", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardController@templates", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/standards": { "get": { "tags": [ "Shared" ], "operationId": "qualityStandardControllerIndexGET", "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": "quality.standards.index", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "qualityStandardControllerStorePOST", "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": "quality.standards.store", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.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/quality/standards-evidence-options": { "get": { "tags": [ "Shared" ], "operationId": "qualityClauseControllerEvidenceOptionsGET", "summary": "Evidence Options", "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": "quality.standards.evidence-options", "x-action": "App\\Domains\\Quality\\Controllers\\QualityClauseController@evidenceOptions", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/standards/from-template": { "post": { "tags": [ "Shared" ], "operationId": "qualityStandardControllerStoreFromTemplatePOST", "summary": "Store From Template", "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": "quality.standards.from-template", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardController@storeFromTemplate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.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/quality/standards/{standard}": { "put": { "tags": [ "Shared" ], "operationId": "qualityStandardControllerUpdatePUT", "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": "quality.standards.update", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "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/quality/standards/{standard}/chapters": { "get": { "tags": [ "Shared" ], "operationId": "qualityStandardChapterControllerIndexGET", "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": "quality.standards.chapters.index", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardChapterController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "qualityStandardChapterControllerStorePOST", "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": "quality.standards.chapters.store", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardChapterController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "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/quality/standards/{standard}/chapters/{chapter}": { "delete": { "tags": [ "Shared" ], "operationId": "qualityStandardChapterControllerDestroyDELETE", "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": "quality.standards.chapters.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardChapterController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "chapter", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "qualityStandardChapterControllerUpdatePUT", "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": "quality.standards.chapters.update", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardChapterController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "chapter", "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/quality/standards/{standard}/clauses": { "get": { "tags": [ "Shared" ], "operationId": "qualityStandardClauseControllerIndexGET", "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": "quality.standards.clauses.index", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardClauseController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "qualityStandardClauseControllerStorePOST", "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": "quality.standards.clauses.store", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardClauseController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "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/quality/standards/{standard}/clauses/{clause}": { "delete": { "tags": [ "Shared" ], "operationId": "qualityStandardClauseControllerDestroyDELETE", "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": "quality.standards.clauses.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardClauseController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clause", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "qualityStandardClauseControllerUpdatePUT", "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": "quality.standards.clauses.update", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardClauseController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clause", "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/quality/standards/{standard}/clauses/{clause}/assessment": { "put": { "tags": [ "Shared" ], "operationId": "qualityClauseControllerUpsertAssessmentPUT", "summary": "Upsert Assessment", "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": "quality.standards.clauses.assessment", "x-action": "App\\Domains\\Quality\\Controllers\\QualityClauseController@upsertAssessment", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clause", "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/quality/standards/{standard}/clauses/{clause}/evidence": { "post": { "tags": [ "Shared" ], "operationId": "qualityClauseControllerStoreEvidencePOST", "summary": "Store Evidence", "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": "quality.standards.clauses.evidence.store", "x-action": "App\\Domains\\Quality\\Controllers\\QualityClauseController@storeEvidence", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clause", "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/quality/standards/{standard}/clauses/{clause}/evidence/{evidence}": { "delete": { "tags": [ "Shared" ], "operationId": "qualityClauseControllerDestroyEvidenceDELETE", "summary": "Destroy Evidence", "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": "quality.standards.clauses.evidence.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\QualityClauseController@destroyEvidence", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality", "permission:quality.standards.manage|quality.settings.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "quality.settings.manage", "quality.standards.manage" ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clause", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "evidence", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/standards/{standard}/tree": { "get": { "tags": [ "Shared" ], "operationId": "qualityStandardControllerTreeGET", "summary": "Tree", "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": "quality.standards.tree", "x-action": "App\\Domains\\Quality\\Controllers\\QualityStandardController@tree", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "standard", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/suppliers": { "get": { "tags": [ "Shared" ], "operationId": "supplierControllerIndexGET", "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": "quality.suppliers.index", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "supplierControllerStorePOST", "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": "quality.suppliers.store", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/suppliers/{supplier}": { "get": { "tags": [ "Shared" ], "operationId": "supplierControllerShowGET", "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": "quality.suppliers.show", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "supplierControllerUpdatePUT", "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": "quality.suppliers.update", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "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/quality/suppliers/{supplier}/approve": { "post": { "tags": [ "Shared" ], "operationId": "supplierControllerApprovePOST", "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": "quality.suppliers.approve", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@approve", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "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/quality/suppliers/{supplier}/capas": { "get": { "tags": [ "Shared" ], "operationId": "supplierControllerIndexCapasGET", "summary": "Index Capas", "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": "quality.suppliers.capas.index", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@indexCapas", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/suppliers/{supplier}/disapprove": { "post": { "tags": [ "Shared" ], "operationId": "supplierControllerDisapprovePOST", "summary": "Disapprove", "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": "quality.suppliers.disapprove", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@disapprove", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "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/quality/suppliers/{supplier}/documents": { "get": { "tags": [ "Shared" ], "operationId": "supplierControllerIndexDocumentsGET", "summary": "Index Documents", "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": "quality.suppliers.documents.index", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@indexDocuments", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "supplierControllerStoreDocumentPOST", "summary": "Store Document", "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": "quality.suppliers.documents.store", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@storeDocument", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "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/quality/suppliers/{supplier}/documents/{document}": { "delete": { "tags": [ "Shared" ], "operationId": "supplierControllerDestroyDocumentDELETE", "summary": "Destroy Document", "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": "quality.suppliers.documents.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@destroyDocument", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/suppliers/{supplier}/evaluations": { "get": { "tags": [ "Shared" ], "operationId": "supplierControllerIndexEvaluationsGET", "summary": "Index Evaluations", "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": "quality.suppliers.evaluations.index", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@indexEvaluations", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "supplierControllerStoreEvaluationPOST", "summary": "Store Evaluation", "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": "quality.suppliers.evaluations.store", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@storeEvaluation", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "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/quality/suppliers/{supplier}/ncrs": { "get": { "tags": [ "Shared" ], "operationId": "supplierControllerIndexNcrsGET", "summary": "Index Ncrs", "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": "quality.suppliers.ncrs.index", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@indexNcrs", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/suppliers/{supplier}/requalify": { "post": { "tags": [ "Shared" ], "operationId": "supplierControllerRequalifyPOST", "summary": "Requalify", "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": "quality.suppliers.requalify", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@requalify", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "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/quality/suppliers/{supplier}/suspend": { "post": { "tags": [ "Shared" ], "operationId": "supplierControllerSuspendPOST", "summary": "Suspend", "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": "quality.suppliers.suspend", "x-action": "App\\Domains\\Quality\\Controllers\\SupplierController@suspend", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "supplier", "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/quality/team-quality/summary": { "get": { "tags": [ "Shared" ], "operationId": "teamQualityControllerSummaryGET", "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": "quality.team-quality.summary", "x-action": "App\\Domains\\Quality\\Controllers\\TeamQualityController@summary", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/training": { "get": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerIndexGET", "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": "quality.training.index", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerStorePOST", "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": "quality.training.store", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/training/matrix": { "get": { "tags": [ "Shared" ], "operationId": "competencyControllerMatrixGET", "summary": "Matrix", "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": "quality.training.matrix", "x-action": "App\\Domains\\Quality\\Controllers\\CompetencyController@matrix", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/quality/training/quiz-questions": { "get": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerIndexQuizQuestionsGET", "summary": "Index Quiz Questions", "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": "quality.training.quiz-questions.index", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@indexQuizQuestions", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerStoreQuizQuestionPOST", "summary": "Store Quiz Question", "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": "quality.training.quiz-questions.store", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@storeQuizQuestion", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "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/quality/training/quiz-questions/{question}": { "delete": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerDestroyQuizQuestionDELETE", "summary": "Destroy Quiz Question", "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": "quality.training.quiz-questions.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@destroyQuizQuestion", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "question", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerUpdateQuizQuestionPUT", "summary": "Update Quiz Question", "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": "quality.training.quiz-questions.update", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@updateQuizQuestion", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "question", "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/quality/training/{assignment}": { "get": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerShowGET", "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": "quality.training.show", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "assignment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/training/{assignment}/complete": { "post": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerCompletePOST", "summary": "Complete", "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": "quality.training.complete", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/training/{assignment}/confirm-effectiveness": { "post": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerConfirmEffectivenessPOST", "summary": "Confirm Effectiveness", "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": "quality.training.confirm-effectiveness", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@confirmEffectiveness", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/training/{assignment}/quiz-attempt": { "post": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerQuizAttemptPOST", "summary": "Quiz Attempt", "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": "quality.training.quiz-attempt", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@quizAttempt", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/training/{assignment}/waive": { "post": { "tags": [ "Shared" ], "operationId": "trainingAssignmentControllerWaivePOST", "summary": "Waive", "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": "quality.training.waive", "x-action": "App\\Domains\\Quality\\Controllers\\TrainingAssignmentController@waive", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "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/quality/{type}/{id}/attachments": { "get": { "tags": [ "Shared" ], "operationId": "qualityAttachmentControllerIndexGET", "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": "quality.attachments.index", "x-action": "App\\Domains\\Quality\\Controllers\\QualityAttachmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/api/quality/{type}/{id}/attachments/intents": { "post": { "tags": [ "Shared" ], "operationId": "qualityAttachmentControllerCreateIntentPOST", "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": "quality.attachments.intents", "x-action": "App\\Domains\\Quality\\Controllers\\QualityAttachmentController@createIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/quality/{type}/{id}/attachments/upload": { "post": { "tags": [ "Shared" ], "operationId": "qualityAttachmentControllerUploadPOST", "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": "quality.attachments.upload", "x-action": "App\\Domains\\Quality\\Controllers\\QualityAttachmentController@upload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/quality/{type}/{id}/attachments/{attachment}": { "delete": { "tags": [ "Shared" ], "operationId": "qualityAttachmentControllerDestroyDELETE", "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": "quality.attachments.destroy", "x-action": "App\\Domains\\Quality\\Controllers\\QualityAttachmentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/{type}/{id}/attachments/{attachment}/complete": { "post": { "tags": [ "Shared" ], "operationId": "qualityAttachmentControllerCompletePOST", "summary": "Complete", "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": "quality.attachments.complete", "x-action": "App\\Domains\\Quality\\Controllers\\QualityAttachmentController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "attachment", "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/quality/{type}/{id}/attachments/{attachment}/download": { "get": { "tags": [ "Shared" ], "operationId": "qualityAttachmentControllerDownloadGET", "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": "quality.attachments.download", "x-action": "App\\Domains\\Quality\\Controllers\\QualityAttachmentController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/quality/{type}/{id}/comments": { "get": { "tags": [ "Shared" ], "operationId": "qualityCommentControllerIndexGET", "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": "quality.comments.index", "x-action": "App\\Domains\\Quality\\Controllers\\QualityCommentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "qualityCommentControllerStorePOST", "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": "quality.comments.store", "x-action": "App\\Domains\\Quality\\Controllers\\QualityCommentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:quality" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "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/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/tasks/dashboard/overview": { "get": { "tags": [ "Shared" ], "operationId": "taskDashboardControllerOverviewGET", "summary": "Overview", "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": "tasks.dashboard.overview", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskDashboardController@overview", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.dashboard.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.dashboard.view" ] } }, "/api/tasks/items": { "get": { "tags": [ "Shared" ], "operationId": "taskControllerIndexGET", "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": "tasks.items.index", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "taskControllerStorePOST", "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": "tasks.items.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.tasks.create" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.tasks.create" ], "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/tasks/items/{task}": { "delete": { "tags": [ "Shared" ], "operationId": "taskControllerDestroyDELETE", "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": "tasks.items.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "taskControllerShowGET", "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": "tasks.items.show", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "taskControllerUpdatePUT", "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": "tasks.items.update", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "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/tasks/items/{task}/activities": { "get": { "tags": [ "Shared" ], "operationId": "taskControllerActivitiesGET", "summary": "Activities", "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": "tasks.items.activities", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@activities", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/tasks/items/{task}/archive": { "patch": { "tags": [ "Shared" ], "operationId": "taskControllerArchivePATCH", "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": "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": "tasks.items.archive", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@archive", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "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/tasks/items/{task}/attachments": { "get": { "tags": [ "Shared" ], "operationId": "taskAttachmentControllerIndexGET", "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": "tasks.items.attachments.index", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskAttachmentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.attachments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.attachments.view" ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/tasks/items/{task}/attachments/intents": { "post": { "tags": [ "Shared" ], "operationId": "taskAttachmentControllerCreateIntentPOST", "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": "tasks.items.attachments.intents.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskAttachmentController@createIntent", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.attachments.upload" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.attachments.upload" ], "parameters": [ { "name": "task", "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/tasks/items/{task}/attachments/upload": { "post": { "tags": [ "Shared" ], "operationId": "taskAttachmentControllerUploadPOST", "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": "tasks.items.attachments.upload", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskAttachmentController@upload", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.attachments.upload" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.attachments.upload" ], "parameters": [ { "name": "task", "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/tasks/items/{task}/attachments/{attachment}": { "delete": { "tags": [ "Shared" ], "operationId": "taskAttachmentControllerDestroyDELETE", "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": "tasks.items.attachments.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskAttachmentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.attachments.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.attachments.delete" ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "taskAttachmentControllerShowGET", "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": "tasks.items.attachments.show", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskAttachmentController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.attachments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.attachments.view" ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/tasks/items/{task}/attachments/{attachment}/complete": { "post": { "tags": [ "Shared" ], "operationId": "taskAttachmentControllerCompletePOST", "summary": "Complete", "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": "tasks.items.attachments.complete", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskAttachmentController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.attachments.upload" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.attachments.upload" ], "parameters": [ { "name": "task", "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": { "notes": { "type": "string" } } }, "example": { "notes": "See endpoint-specific request fields in route/controller docs." } } } } } }, "/api/tasks/items/{task}/attachments/{attachment}/download": { "get": { "tags": [ "Shared" ], "operationId": "taskAttachmentControllerDownloadGET", "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": "tasks.items.attachments.download", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskAttachmentController@download", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.attachments.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.attachments.view" ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/tasks/items/{task}/comments": { "get": { "tags": [ "Shared" ], "operationId": "taskCommentControllerIndexGET", "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": "tasks.items.comments.index", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskCommentController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "taskCommentControllerStorePOST", "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": "tasks.items.comments.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskCommentController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "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/tasks/items/{task}/comments/{comment}": { "delete": { "tags": [ "Shared" ], "operationId": "taskCommentControllerDestroyDELETE", "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": "tasks.items.comments.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskCommentController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "taskCommentControllerUpdatePUT", "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": "tasks.items.comments.update", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskCommentController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "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/tasks/items/{task}/comments/{comment}/reactions": { "post": { "tags": [ "Shared" ], "operationId": "taskCommentControllerToggleReactionPOST", "summary": "Toggle Reaction", "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": "tasks.items.comments.reactions.toggle", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskCommentController@toggleReaction", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "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/tasks/items/{task}/dependencies": { "post": { "tags": [ "Shared" ], "operationId": "taskDependencyControllerStorePOST", "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": "tasks.items.dependencies.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskDependencyController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "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/tasks/items/{task}/dependencies/{dependency}": { "delete": { "tags": [ "Shared" ], "operationId": "taskDependencyControllerDestroyDELETE", "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": "tasks.items.dependencies.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskDependencyController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dependency", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/tasks/items/{task}/labels": { "post": { "tags": [ "Shared" ], "operationId": "taskLabelControllerSyncTaskLabelsPOST", "summary": "Sync Task Labels", "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": "tasks.items.labels.sync", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskLabelController@syncTaskLabels", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "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/tasks/items/{task}/move": { "post": { "tags": [ "Shared" ], "operationId": "taskControllerMovePOST", "summary": "Move", "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": "tasks.items.move", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@move", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "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/tasks/items/{task}/time-logs": { "get": { "tags": [ "Shared" ], "operationId": "taskTimeLogControllerIndexGET", "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": "tasks.items.time_logs.index", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskTimeLogController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "taskTimeLogControllerStorePOST", "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": "tasks.items.time_logs.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskTimeLogController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.time_logs.create.own" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.time_logs.create.own" ], "parameters": [ { "name": "task", "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/tasks/items/{task}/time-logs/{log}": { "delete": { "tags": [ "Shared" ], "operationId": "taskTimeLogControllerDestroyDELETE", "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": "tasks.items.time_logs.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskTimeLogController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "log", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "taskTimeLogControllerUpdatePUT", "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": "tasks.items.time_logs.update", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskTimeLogController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "log", "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/tasks/items/{task}/watch": { "delete": { "tags": [ "Shared" ], "operationId": "taskWatcherControllerDestroyDELETE", "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": "tasks.items.unwatch", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskWatcherController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "taskWatcherControllerStorePOST", "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": "tasks.items.watch", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskWatcherController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "task", "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/tasks/labels": { "get": { "tags": [ "Shared" ], "operationId": "taskLabelControllerIndexGET", "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": "tasks.labels.index", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskLabelController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] }, "post": { "tags": [ "Shared" ], "operationId": "taskLabelControllerStorePOST", "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": "tasks.labels.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskLabelController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.labels.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.labels.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/tasks/labels/{label}": { "delete": { "tags": [ "Shared" ], "operationId": "taskLabelControllerDestroyDELETE", "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": "tasks.labels.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskLabelController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.labels.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.labels.manage" ], "parameters": [ { "name": "label", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "taskLabelControllerUpdatePUT", "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": "tasks.labels.update", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskLabelController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.labels.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.labels.manage" ], "parameters": [ { "name": "label", "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/tasks/linked": { "get": { "tags": [ "Shared" ], "operationId": "taskControllerLinkedGET", "summary": "Linked", "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": "tasks.items.linked", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@linked", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ] } }, "/api/tasks/projects": { "get": { "tags": [ "Shared" ], "operationId": "taskProjectControllerIndexGET", "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": "tasks.projects.index", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.view" ] }, "post": { "tags": [ "Shared" ], "operationId": "taskProjectControllerStorePOST", "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": "tasks.projects.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@store", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.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/tasks/projects/templates": { "get": { "tags": [ "Shared" ], "operationId": "taskProjectControllerListTemplatesGET", "summary": "List Templates", "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": "tasks.projects.templates.index", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@listTemplates", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.view" ] } }, "/api/tasks/projects/{project}": { "delete": { "tags": [ "Shared" ], "operationId": "taskProjectControllerDestroyDELETE", "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": "tasks.projects.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@destroy", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.delete" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.delete" ], "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Shared" ], "operationId": "taskProjectControllerShowGET", "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": "tasks.projects.show", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@show", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "taskProjectControllerUpdatePUT", "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": "tasks.projects.update", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@update", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/archive": { "patch": { "tags": [ "Shared" ], "operationId": "taskProjectControllerArchivePATCH", "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": "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": "tasks.projects.archive", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@archive", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/baseline": { "delete": { "tags": [ "Shared" ], "operationId": "taskProjectControllerClearBaselineDELETE", "summary": "Clear Baseline", "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": "tasks.projects.baseline.clear", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@clearBaseline", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Shared" ], "operationId": "taskProjectControllerSetBaselinePOST", "summary": "Set Baseline", "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": "tasks.projects.baseline.set", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@setBaseline", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/complete": { "patch": { "tags": [ "Shared" ], "operationId": "taskProjectControllerCompletePATCH", "summary": "Complete", "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": "tasks.projects.complete", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@complete", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/duplicate": { "post": { "tags": [ "Shared" ], "operationId": "taskProjectControllerDuplicatePOST", "summary": "Duplicate", "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": "tasks.projects.duplicate", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@duplicate", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/gantt": { "get": { "tags": [ "Shared" ], "operationId": "taskProjectControllerGanttGET", "summary": "Gantt", "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": "tasks.projects.gantt", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@gantt", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/tasks/projects/{project}/members": { "post": { "tags": [ "Shared" ], "operationId": "taskProjectControllerAddMemberPOST", "summary": "Add Member", "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": "tasks.projects.members.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@addMember", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/members/{member}": { "delete": { "tags": [ "Shared" ], "operationId": "taskProjectControllerRemoveMemberDELETE", "summary": "Remove Member", "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": "tasks.projects.members.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@removeMember", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "member", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/tasks/projects/{project}/milestones": { "post": { "tags": [ "Shared" ], "operationId": "taskProjectControllerStoreMilestonePOST", "summary": "Store Milestone", "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": "tasks.projects.milestones.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@storeMilestone", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/milestones/{milestone}": { "delete": { "tags": [ "Shared" ], "operationId": "taskProjectControllerDestroyMilestoneDELETE", "summary": "Destroy Milestone", "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": "tasks.projects.milestones.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@destroyMilestone", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "milestone", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "taskProjectControllerUpdateMilestonePUT", "summary": "Update Milestone", "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": "tasks.projects.milestones.update", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@updateMilestone", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "milestone", "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/tasks/projects/{project}/reorder": { "post": { "tags": [ "Shared" ], "operationId": "taskControllerReorderPOST", "summary": "Reorder", "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": "tasks.items.reorder", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskController@reorder", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/statuses": { "post": { "tags": [ "Shared" ], "operationId": "taskProjectControllerStoreStatusPOST", "summary": "Store Status", "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": "tasks.projects.statuses.store", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@storeStatus", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/statuses/reorder": { "post": { "tags": [ "Shared" ], "operationId": "taskProjectControllerReorderStatusesPOST", "summary": "Reorder Statuses", "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": "tasks.projects.statuses.reorder", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@reorderStatuses", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "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/tasks/projects/{project}/statuses/{status}": { "delete": { "tags": [ "Shared" ], "operationId": "taskProjectControllerDestroyStatusDELETE", "summary": "Destroy Status", "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": "tasks.projects.statuses.destroy", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@destroyStatus", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "Shared" ], "operationId": "taskProjectControllerUpdateStatusPUT", "summary": "Update Status", "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": "tasks.projects.statuses.update", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskProjectController@updateStatus", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.projects.manage" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.projects.manage" ], "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "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/tasks/reports/export": { "get": { "tags": [ "Shared" ], "operationId": "taskReportControllerExportGET", "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": "tasks.reports.export", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskReportController@export", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.reports.export" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.reports.export" ] } }, "/api/tasks/workload": { "get": { "tags": [ "Shared" ], "operationId": "taskWorkloadControllerIndexGET", "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": "tasks.workload.index", "x-action": "App\\Domains\\Tasks\\Controllers\\TaskWorkloadController@index", "x-middleware": [ "api", "auth:sanctum", "company.context", "feature:tasks", "permission:tasks.workload.view" ], "security": [ { "bearerAuth": [], "CompanyContextHeader": [] } ], "x-required-permissions": [ "tasks.workload.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." } } } } } } } }