package api

// ResponseEnvelope is the standard wrapper for EZ-API JSON responses.
// Code is a numeric business code: 0 for success, non-zero for errors.
// Message is "success" for success, error description for failures.
// Data holds the original response payload for success; null for errors.
// TraceID is a request correlation identifier.
// Details holds optional structured error information.
// swagger:model ResponseEnvelope
type ResponseEnvelope struct {
	Code    int    `json:"code" example:"0"`
	Message string `json:"message" example:"success"`
	Data    any    `json:"data" swaggertype:"object"`
	TraceID string `json:"trace_id" example:"a1b2c3d4e5f6g7h8"`
	Details any    `json:"details,omitempty" swaggertype:"object"`
}

// MapData represents a generic JSON object for documentation purposes.
type MapData map[string]any