json-schema.crudCommon.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 ."],
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "definitions": {
        "query": {
            "$ref": "/json-schema/query/choice.json#/definitions/query"
        },
        "projection": {
            "$ref": "/json-schema/projection/choice.json#/definitions/projection",
            "description": "A projection expression specifying what fields of entities to return once the insert/update/delete is performed. For insert/update operations, the projection is performed on the updated entity. For deletion, projection is performed on the entity currently in db. Empty projection list is allowed. WARN: Requesting more than the unique IDs of entities might require a re-fetch of entities."
        },
        "version": {
            "$ref": "/json-schema/metadata/common.json#/definitions/version/value",
            "description": "The version of metadata. Defaults to latest version."
        },
        "data": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string",
                    "description": "The id of the entity."
                },
                "objectType": {
                    "type": "string",
                    "description": "The name of the entity to be operated on.  Should match 'objectType' set at higher level."
                },
                "version": {
                    "$ref": "#/definitions/version"
                }
            },
            "required": [
                "objectType"
            ],
            "additionalProperties": true
        },
        "dataArray": {
            "type": "array",
            "description": "Array of entity objects. If object ids are given, entities will be inserted with the given object id, otherwise object id will be auto-generated.",
            "items": {
                "$ref": "#/definitions/data"
            }
        },
        "execution": {
            "type": "object",
            "description": "Execution options captured as key/value pairs.  See documentation on http://lightblue.io for what is supporeted",
            "additionalProperties": true
        },
        "client": {
            "description": "If omitted, the call executes as role 'anyone'. This field contains the authentication information for the caller, which is auth implementation specific, or a session identifier obtained from an earlier call.",
            "type": "object",
            "properties": {
                "id": {
                    "type": "string",
                    "description": "Identifier for the client"
                }
            },
            "additionalProperties": true
        },
        "common": {
            "properties": {
                "entity": {
                    "type": "string",
                    "description": "The name of the entity being operated on."
                },
                "client": {
                    "$ref": "#/definitions/client"
                },
                "version": {
                    "$ref": "#/definitions/version"
                },
                "execution": {
                    "$ref": "#/definitions/execution"
                },
                "projection": {
                    "$ref": "#/definitions/projection"
                }
            },
            "required": [
                "entity"
            ]
        }
    }
}