Class ApiInnerError
- Namespace
- GroupeIsa.Neos.ClusterCommunication.Errors
- Assembly
- GroupeIsa.Neos.ClusterCommunication.dll
Represents an inner error in an API response.
[ExcludeFromCodeCoverage(Justification = "Data class")]
public class ApiInnerError
- Inheritance
-
ApiInnerError
- Derived
- Inherited Members
Properties
Detail
Gets or sets a human-readable explanation specific to this occurrence of the problem.
public string? Detail { get; set; }
Property Value
Remarks
Example : "Parameter 'id' with value 'test' is invalid.
Extensions
Gets or sets the System.Collections.Generic.IDictionary`2 for extension members. Problem type definitions MAY extend the problem details object with additional members. Extension members appear in the same namespace as other members of a problem type.
public IDictionary<string, object?> Extensions { get; set; }
Property Value
Remarks
The round-tripping behavior for Microsoft.AspNetCore.Mvc.ProblemDetails.Extensions is determined by the implementation of the Input \ Output formatters. In particular, complex types or collection types may not round-trip to the original type when using the built-in JSON or XML formatters.
Instance
Gets or sets a URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. Can be relative to the URI defined in the Type property.
public string? Instance { get; set; }
Property Value
Remarks
Example : "/invalidparametervalue".
Technical
Gets or sets a value indicating whether the error message is technical or not. Technical error messages are not displayed to users.
public bool Technical { get; set; }
Property Value
Title
Gets or sets a short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4).
public string Title { get; set; }
Property Value
Remarks
Example : "Invalid model".
Type
Gets or sets a URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".
public string Type { get; set; }
Property Value
Remarks
"Example : "https://doc.neos.com/errors/invalidmodel".