json-schema.response.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lightblue-core-crud Show documentation
There is a newer version: 2.18.0
{
    "copyright": [
        "Copyright 2013 Red Hat, Inc. and/or its affiliates.",
        "This file is part of lightblue.",
        "This program is free software: you can redistribute it and/or modify",
        "it under the terms of the GNU General Public License as published by",
        "the Free Software Foundation, either version 3 of the License, or",
        "(at your option) any later version.",
        "This program is distributed in the hope that it will be useful,",
        "but WITHOUT ANY WARRANTY; without even the implied warranty of",
        "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the",
        "GNU General Public License for more details.",
        "You should have received a copy of the GNU General Public License",
        "along with this program.  If not, see ."],
    "id": "#response",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "status": {
            "enum": [
                "COMPLETE",
                "PARTIAL",
                "ASYNC",
                "ERROR"
            ],
            "description": "COMPLETE: The operation completed, all requests are processed
PARTIAL: Some of the operations are successful, some failed
ASYNC: Operation running asynchronously
ERROR: Operation failed because of some system error"
        },
        "entity": {
            "type":"string",
            "description":"The entity name"
        },
        "entityVersion":{
            "type":"string",
            "description":"The entity version"
        },
        "modifiedCount": {
            "type": "integer",
            "description": "number of entities affected by the call, if this is an insert, update, or delete"
        },
        "matchCount": {
            "type": "integer",
            "description": "total number of entities in the result set, if this is a find."
        },
        "taskHandle": {
            "type": "string",
            "description": "Only present if aysnchronous operation is requested, and status=async. Contains the task handle that the client can use to retrieve status information about the ongoing execution"
        },
        "session": {
            "type": "object",
            "additionalProperties": true,
            "description": "Session information for the client. How this is used is implementation dependent, and TBD"
        },
        "resultMetadata":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "documentVersion": {
                        "type":"string",
                        "description":"Unique string identifying the document at a point in time"
                    }
                },
                "additionalProperties":true
            },
            "description":"Result metadata, each element corresponds to the same indexed element in the processed array"
        },
        "processed": {
            "type": "array",
            "items": {
                "type": "object",
                "additionalProperties": true
            },
            "description": "Projected entity information for processed entities. Applicable for all operations. Contains only successfully updated entities if insert, update, or delete. It is up to the caller to project identifying fields if caller needs."
        },
        "dataErrors": {
            "type": "array",
            "items": {
                "properties": {
                    "data": {
                        "type": "object",
                        "additionalProperties": true,
                        "description": "Projected entity data"
                    },
                    "errors": {
                        "type": "array",
                        "items": {
                            "$ref": "/json-schema/error/error.json#"
                        },
                        "description": "Array of errors for that particular object"
                    }
                }
            }
        },
        "errors": {
            "type": "array",
            "items": {
                "$ref": "/json-schema/error/error.json#"
            },
            "description": "Errors not related to data"
        }
    },
    "required": [
        "status"
    ],
    "additionalProperties": true
}