##// END OF EJS Templates
Misc style changes to descriptions
Jessica B. Hamrick -
Show More
@@ -1,171 +1,172 b''
1 {
1 {
2 "$schema": "http://json-schema.org/draft-03/schema#",
2 "$schema": "http://json-schema.org/draft-03/schema#",
3 "description": "IPython Notebook v4.0 JSON schema.",
3 "description": "IPython Notebook v4.0 JSON schema.",
4 "type": "object",
4 "type": "object",
5 "additionalProperties": false,
5 "additionalProperties": false,
6 "properties": {
6 "properties": {
7 "metadata": {
7 "metadata": {
8 "description": "Notebook root-level metadata.",
8 "description": "Notebook root-level metadata.",
9 "type": "object",
9 "type": "object",
10 "required": true,
10 "required": true,
11 "additionalProperties": true,
11 "additionalProperties": true,
12 "properties": {
12 "properties": {
13 "language": {
13 "language": {
14 "description": "Language of the notebook's kernel.",
14 "description": "Language of the notebook's kernel.",
15 "type": "string",
15 "type": "string",
16 "required": true
16 "required": true
17 },
17 },
18 "kernel_info": {
18 "kernel_info": {
19 "description": "Other kernel information, to be determined."
19 "description": "Other kernel information, to be determined."
20 "type": "object",
20 "type": "object",
21 "required": true,
21 "required": true,
22 "additionalProperties": true
22 "additionalProperties": true
23 }
23 }
24 }
24 }
25 },
25 },
26 "nbformat_minor": {
26 "nbformat_minor": {
27 "description": "Notebook format (minor number). Incremented for slight changes to the notebook format.",
27 "description": "Notebook format (minor number). Incremented for slight changes to the notebook format.",
28 "type": "integer",
28 "type": "integer",
29 "required": true,
29 "required": true,
30 "minimum": 0
30 "minimum": 0
31 },
31 },
32 "nbformat": {
32 "nbformat": {
33 "description": "Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.",
33 "description": "Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.",
34 "type": "integer",
34 "type": "integer",
35 "required": true,
35 "required": true,
36 "minimum": 4
36 "minimum": 4
37 },
37 },
38 "orig_nbformat": {
38 "orig_nbformat": {
39 "description": "Original notebook format (major number) before converting the notebook between versions.",
39 "description": "Original notebook format (major number) before converting the notebook between versions.",
40 "type": "integer",
40 "type": "integer",
41 "required": false,
41 "required": false,
42 "minimum": 1
42 "minimum": 1
43 },
43 },
44 "cells": {
44 "cells": {
45 "description": "array of cells of the current notebook",
45 "description": "Array of cells of the current notebook.",
46 "type": "array",
46 "type": "array",
47 "required": true,
47 "required": true,
48 "items": {
48 "items": {
49 "type": [
49 "type": [
50 {"$ref": "#/definitions/text_cell"},
50 {"$ref": "#/definitions/text_cell"},
51 {"$ref": "#/definitions/heading_cell"},
51 {"$ref": "#/definitions/heading_cell"},
52 {"$ref": "#/definitions/code_cell"}
52 {"$ref": "#/definitions/code_cell"}
53 ]
53 ]
54 }
54 }
55 }
55 }
56 },
56 },
57
57
58 "definitions": {
58 "definitions": {
59
59
60 "text_cell": {
60 "text_cell": {
61 "description": "Notebook text cell",
61 "description": "Notebook text cell.",
62 "type": "object",
62 "type": "object",
63 "additionalProperties": false,
63 "additionalProperties": false,
64 "properties": {
64 "properties": {
65 "cell_type": {
65 "cell_type": {
66 "description": "String identifying the type of cell",
66 "description": "String identifying the type of cell.",
67 "enum": ["markdown", "raw"],
67 "enum": ["markdown", "raw"],
68 "required": true
68 "required": true
69 },
69 },
70 "metadata": {
70 "metadata": {
71 "description": "Cell-level metadata",
71 "description": "Cell-level metadata.",
72 "type": "object",
72 "type": "object",
73 "required": true,
73 "required": true,
74 "additionalProperties": true
74 "additionalProperties": true
75 },
75 },
76 "source": {
76 "source": {
77 "description": "Contents of the cell, represented as an array of lines (each terminated by \n)",
77 "description": "Contents of the cell, represented as an array of lines (each terminated by \n).",
78 "type": "array",
78 "type": "array",
79 "required": true,
79 "required": true,
80 "items": {
80 "items": {
81 "type": "string",
81 "type": "string",
82 "pattern": "^.*\n$"
82 "pattern": "^.*\n$"
83 }
83 }
84 }
84 }
85 }
85 }
86 },
86 },
87
87
88 "heading_cell": {
88 "heading_cell": {
89 "description": "Notebook heading cell",
89 "description": "Notebook heading cell.",
90 "type": "object",
90 "type": "object",
91 "additionalProperties": false,
91 "additionalProperties": false,
92 "properties": {
92 "properties": {
93 "cell_type": {
93 "cell_type": {
94 "description": "String identifying the type of cell",
94 "description": "String identifying the type of cell.",
95 "enum": ["heading"],
95 "enum": ["heading"],
96 "required": true
96 "required": true
97 },
97 },
98 "metadata": {
98 "metadata": {
99 "description": "Cell-level metadata",
99 "description": "Cell-level metadata.",
100 "type": "object",
100 "type": "object",
101 "required": true,
101 "required": true,
102 "additionalProperties": true
102 "additionalProperties": true
103 },
103 },
104 "source": {
104 "source": {
105 "description": "Contents of the cell, represented as an array of lines (each terminated by \n)",
105 "description": "Contents of the cell, represented as an array of lines (each terminated by \n).",
106 "type": "array",
106 "type": "array",
107 "required": true,
107 "required": true,
108 "items": {
108 "items": {
109 "type": "string",
109 "type": "string",
110 "pattern": "^.*\n$"
110 "pattern": "^.*\n$"
111 }
111 }
112 },
112 },
113 "level": {
113 "level": {
114 "description": "Level of heading cells",
114 "description": "Level of heading cells.",
115 "type": "integer",
115 "type": "integer",
116 "required": false,
116 "required": true,
117 "minimum": 1,
117 "minimum": 1,
118 "maximum": 6
118 "maximum": 6
119 }
119 }
120 }
120 }
121 },
121 },
122
122
123 "code_cell": {
123 "code_cell": {
124 "description": "Notebook code cell",
124 "description": "Notebook code cell.",
125 "type": "object",
125 "type": "object",
126 "additionalProperties": false,
126 "additionalProperties": false,
127 "properties": {
127 "properties": {
128 "cell_type": {
128 "cell_type": {
129 "description": "String identifying the type of cell",
129 "description": "String identifying the type of cell.",
130 "enum": ["code"],
130 "enum": ["code"],
131 "required": true
131 "required": true
132 },
132 },
133 "metadata": {
133 "metadata": {
134 "description": "Cell-level metadata",
134 "description": "Cell-level metadata.",
135 "type": "object",
135 "type": "object",
136 "required": true,
136 "required": true,
137 "additionalProperties": true
137 "additionalProperties": true
138 },
138 },
139 "source": {
139 "source": {
140 "description": "Contents of the cell, represented as an array of lines (each terminated by \n)",
140 "description": "Contents of the cell, represented as an array of lines (each terminated by \n).",
141 "type": "array",
141 "type": "array",
142 "required": true,
142 "required": true,
143 "items": {
143 "items": {
144 "type": "string",
144 "type": "string",
145 "pattern": "^.*\n$"
145 "pattern": "^.*\n$"
146 }
146 }
147 }
147 }
148 "outputs": {
148 "outputs": {
149 "description": "Outputs of cell, to be defined",
149 "description": "Outputs of cell, to be defined.",
150 "type": "array",
150 "type": "array",
151 "required": true
151 "required": true
152 },
152 },
153 "collapsed": {
153 "collapsed": {
154 "description": "Whether the cell is collapsed/expanded",
154 "description": "Whether the cell is collapsed/expanded.",
155 "type": "boolean",
155 "type": "boolean",
156 "required": true
156 "required": true
157 },
157 },
158 "autoscroll": {
158 "autoscroll": {
159 "description": "Whether the cell's output should autoscroll",
159 "description": "Whether the cell's output should autoscroll.",
160 "type": "boolean",
160 "type": "boolean",
161 "required": true
161 "required": true
162 },
162 },
163 "prompt_number": {
163 "prompt_number": {
164 "description": "The code cell's prompt number. Will be null if the cell has not been run.",
164 "type": ["integer", "null"],
165 "type": ["integer", "null"],
165 "required": true,
166 "required": true,
166 "minimum": 0
167 "minimum": 0
167 }
168 }
168 }
169 }
169 }
170 }
170 }
171 }
171 }
172 }
General Comments 0
You need to be logged in to leave comments. Login now