modelspec/examples/document.specification.json at main · ModECI/modelspec · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
    "Document": {
        "definition": "A model for documents.",
        "allowed_parameters": {
            "id": {
                "type": "str",
                "description": "The unique id of the document"
            },
            "title": {
                "type": "str",
                "description": "The document title"
            },
            "ISBN": {
                "type": "int",
                "description": "International Standard Book Number"
            }
        },
        "allowed_children": {
            "sections": {
                "type": "Section",
                "description": "The sections of the document"
            }
        }
    },
    "Section": {
        "definition": "A model of a section of the :class:`Document`. Will contain one :class:`Paragraph` or more, i.e the :class:`Paragraph`(s) in the section, probably related to the :code:`title` of the `Document <#document>`_.",
        "allowed_parameters": {
            "id": {
                "type": "str",
                "description": "The id of the section"
            }
        },
        "allowed_children": {
            "paragraphs": {
                "type": "Paragraph",
                "description": "The paragraphs"
            }
        }
    },
    "Paragraph": {
        "definition": "A model of a paragraph.",
        "allowed_parameters": {
            "contents": {
                "type": "str",
                "description": "Paragraph contents, which make up the :class:`Section`s."
            }
        }
    }
}