The status document returned by the importConfiguration MBean operation and importdeclarativeconfig rhino-console command.
This document consists of a status value and details of the result of the import operation.
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"$defs" : {
"ErrorWithContext" : {
"type" : "object",
"properties" : {
"context" : {
"$ref" : "#/$defs/Span",
"description" : "The context of the error in the configuration bundle."
},
"level" : {
"$ref" : "#/$defs/Level",
"description" : "Severity level of the message."
},
"location" : {
"type" : [ "string", "null" ],
"description" : "YPath format path identifying the structural location in the configuration bundle where the error was found."
},
"message" : {
"type" : "string",
"description" : "Message text summarising the problem."
}
}
},
"JsonThrowable-nullable" : {
"type" : [ "object", "null" ],
"properties" : {
"message" : {
"type" : "string"
},
"stacktrace" : {
"type" : "string"
},
"type" : {
"type" : "string",
"description" : "Class of the exception or error"
}
}
},
"Level" : {
"type" : "string",
"enum" : [ "Info", "Warning", "Error" ]
},
"Location" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
}
},
"MergeErrorMessage" : {
"type" : "object",
"properties" : {
"context" : {
"$ref" : "#/$defs/Span",
"description" : "The context of the error in the configuration bundle."
},
"level" : {
"$ref" : "#/$defs/Level",
"description" : "Severity level of the message."
},
"location" : {
"type" : [ "string", "null" ],
"description" : "YPath format path identifying the structural location in the configuration bundle where the error was found."
},
"message" : {
"type" : "string",
"description" : "Message text summarising the problem."
},
"selection" : {
"$ref" : "#/$defs/Span",
"description" : "Section of the configuration bundle that contains the conflicting values."
}
}
},
"SimpleErrorMessage" : {
"type" : "object",
"properties" : {
"cause" : {
"$ref" : "#/$defs/JsonThrowable-nullable",
"description" : "The cause of the error."
},
"level" : {
"$ref" : "#/$defs/Level",
"description" : "Severity level of the message."
},
"location" : {
"type" : [ "string", "null" ],
"description" : "YPath format path identifying the structural location in the configuration bundle where the error was found."
},
"message" : {
"type" : "string",
"description" : "Message text summarising the problem."
}
}
},
"Span" : {
"type" : "object",
"properties" : {
"end" : {
"$ref" : "#/$defs/Location",
"description" : "End location in the input document."
},
"name" : {
"type" : "string",
"description" : "File name of the input document. This is the configuration fragment name in a configuration bundle."
},
"start" : {
"$ref" : "#/$defs/Location",
"description" : "Start location in the input document."
},
"text" : {
"type" : "string",
"description" : "Text between the start and end locations in the input document."
}
}
},
"Status" : {
"type" : "string",
"enum" : [ "Success", "Failure" ]
}
},
"type" : "object",
"properties" : {
"deltas" : {
"type" : [ "string", "null" ],
"description" : "Description of the state changes that resulted from this import operation."
},
"messages" : {
"description" : "Error, warning and informational messages providing details of the status and reason returned.",
"type" : [ "array", "null" ],
"items" : {
"anyOf" : [ {
"$ref" : "#/$defs/SimpleErrorMessage"
}, {
"$ref" : "#/$defs/ErrorWithContext"
}, {
"$ref" : "#/$defs/MergeErrorMessage"
} ]
}
},
"reason" : {
"type" : [ "string", "null" ],
"description" : "Summary of why the import failed validation."
},
"status" : {
"$ref" : "#/$defs/Status",
"description" : "Overall status of the import operation (success or failure)."
}
}
}
