// ***********************************************************************
// <copyright file="HttpErrorDto.cs">
//     Heath
// </copyright>
// ***********************************************************************

using System.ComponentModel;
using System.Text.Json.Serialization;

namespace Core.Blueprint.Logging
{
    /// <summary>
    /// The service HTTP error data transfer object.
    /// </summary>
    public class HttpError
    {
        /// <summary>
        /// Gets or sets the error.
        /// </summary>
        [DisplayName(DisplayNames.Error)]
        [JsonPropertyName(DisplayNames.Error)]
        public ErrorDetails Error { get; set; }

        /// <summary>
        /// Creates a new instance of <see cref="HttpError{TMessage}"/>
        /// with custom parameters.
        /// </summary>
        /// <param name="message">The HTTP error message.</param>
        /// <param name="errorCode">The HTTP error code.</param>
        /// <param name="target">The HTTP error target.</param>
        public HttpError(
            string? message,
            string? errorCode,
            string? target)
        {
            Error = new ErrorDetails
            {
                ErrorCode = errorCode,
                Message = message,
                Target = target,
            };
        }
    }
}