bwinkers/nugget

View on GitHub
objects-izzup/Action.json

Summary

Maintainability
Test Coverage
{
    "title": "Action",
    "description": "An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument. The execution of the action may produce a result. Specific action sub-type documentation specifies the exact expectation of each argument/role.",
    "required": [
        "coreType",
        "name"
    ],
    "properties": {
        "actionStatus": {
            "description": "Indicates the current disposition of the Action.",
            "$ref": "https://schema.izzup.com/ActionStatusType"
        },
        "additionalType": {
            "description": "An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.",
            "nuggetType": "URL",
            "type": "string"
        },
        "agent": {
            "description": "The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book.",
            "oneOf": [
                {
                    "$ref": "https://schema.izzup.com/Organization"
                },
                {
                    "$ref": "https://schema.izzup.com/Person"
                }
            ]
        },
        "alternateName": {
            "description": "An alias for the item.",
            "nuggetType": "Text",
            "type": "string"
        },
        "coreType": {
            "description": "The core ActiveRules type",
            "type": "string",
            "enum": [
                "Person",
                "Product",
                "Event",
                "PublishedWork"
            ]
        },
        "description": {
            "description": "A description of the item.",
            "nuggetType": "Text",
            "type": "string"
        },
        "endTime": {
            "description": "The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.",
            "nuggetType": "DateTime",
            "type": "string"
        },
        "error": {
            "description": "For failed actions, more information on the cause of the failure.",
            "$ref": "https://schema.izzup.com/Thing"
        },
        "identifier": {
            "description": "The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.",
            "oneOf": [
                {
                    "$ref": "https://schema.izzup.com/PropertyValue"
                },
                {
                    "nuggetType": "Text",
                    "type": "string"
                },
                {
                    "nuggetType": "URL",
                    "type": "string"
                }
            ]
        },
        "image": {
            "description": "An image of the item. This can be a URL or a fully described ImageObject.",
            "oneOf": [
                {
                    "$ref": "https://schema.izzup.com/ImageObject"
                },
                {
                    "nuggetType": "URL",
                    "type": "string"
                }
            ]
        },
        "instrument": {
            "description": "The object that helped the agent perform the action. e.g. John wrote a book with a pen.",
            "$ref": "https://schema.izzup.com/Thing"
        },
        "name": {
            "description": "The name of the item.",
            "nuggetType": "Text",
            "type": "string"
        },
        "object": {
            "description": "The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book.",
            "$ref": "https://schema.izzup.com/Thing"
        },
        "participant": {
            "description": "Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve.",
            "oneOf": [
                {
                    "$ref": "https://schema.izzup.com/Organization"
                },
                {
                    "$ref": "https://schema.izzup.com/Person"
                }
            ]
        },
        "potentialAction": {
            "description": "Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.",
            "$ref": "https://schema.izzup.com/Action"
        },
        "result": {
            "description": "The result produced in the action. e.g. John wrote a book.",
            "$ref": "https://schema.izzup.com/Thing"
        },
        "sameAs": {
            "description": "URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.",
            "nuggetType": "URL",
            "type": "string"
        },
        "startTime": {
            "description": "The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.",
            "nuggetType": "DateTime",
            "type": "string"
        },
        "subjectOf": {
            "description": "A CreativeWork or Event about this Thing.. Inverse property: about.",
            "oneOf": [
                {
                    "$ref": "https://schema.izzup.com/CreativeWork"
                },
                {
                    "$ref": "https://schema.izzup.com/Event"
                }
            ]
        },
        "target": {
            "description": "Indicates a target EntryPoint for an Action.",
            "$ref": "https://schema.izzup.com/EntryPoint"
        },
        "url": {
            "description": "URL of the item.",
            "nuggetType": "URL",
            "type": "string"
        }
    },
    "extends": "Thing",
    "type": "object"
}