| 1 | {
|
| 2 | "$schema": "http://json-schema.org/draft-06/schema#",
|
| 3 | "definitions": {
|
| 4 | "Attribute": {
|
| 5 | "properties": {
|
| 6 | "defaultValue": {
|
| 7 | "description": "The default value of the attribute, if any.\n\nAs attributes are always strings, this is the actual value, not a human\nreadable description.",
|
| 8 | "type": "string"
|
| 9 | },
|
| 10 | "description": {
|
| 11 | "description": "A markdown description for the attribute.",
|
| 12 | "type": "string"
|
| 13 | },
|
| 14 | "inheritedFrom": {
|
| 15 | "description": "The identifier of the class or mixin that declared this property.",
|
| 16 | "type": "string"
|
| 17 | },
|
| 18 | "metadata": {
|
| 19 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 20 | },
|
| 21 | "name": {
|
| 22 | "description": "The name of the attribute. e.g. `value`, `icon`, `should-collapse`.",
|
| 23 | "type": "string"
|
| 24 | },
|
| 25 | "sourceRange": {
|
| 26 | "$ref": "#/definitions/SourceRange",
|
| 27 | "description": "Where this feature is defined in source code."
|
| 28 | },
|
| 29 | "type": {
|
| 30 | "description": "The type that the attribute will be serialized/deserialized as.\n\ne.g. `string`, `number`, `boolean`, `RegExp`, `Array`, `Object`.",
|
| 31 | "type": "string"
|
| 32 | }
|
| 33 | },
|
| 34 | "required": [
|
| 35 | "name"
|
| 36 | ],
|
| 37 | "type": "object"
|
| 38 | },
|
| 39 | "Class": {
|
| 40 | "properties": {
|
| 41 | "demos": {
|
| 42 | "description": "Paths, relative to the base directory of the package, to demo pages for\nthis feauture.\n\ne.g. `[{url: 'demos/index.html', description: 'How it works'}, ...]`",
|
| 43 | "items": {
|
| 44 | "$ref": "#/definitions/Demo"
|
| 45 | },
|
| 46 | "type": "array"
|
| 47 | },
|
| 48 | "description": {
|
| 49 | "description": "A markdown description.",
|
| 50 | "type": "string"
|
| 51 | },
|
| 52 | "metadata": {
|
| 53 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 54 | },
|
| 55 | "methods": {
|
| 56 | "description": "The instance methods that this feature has.",
|
| 57 | "items": {
|
| 58 | "$ref": "#/definitions/Method"
|
| 59 | },
|
| 60 | "type": "array"
|
| 61 | },
|
| 62 | "mixins": {
|
| 63 | "description": "Names of mixins applied.",
|
| 64 | "items": {
|
| 65 | "type": "string"
|
| 66 | },
|
| 67 | "type": "array"
|
| 68 | },
|
| 69 | "name": {
|
| 70 | "description": "The name of the class.",
|
| 71 | "type": "string"
|
| 72 | },
|
| 73 | "path": {
|
| 74 | "description": "The path, relative to the base directory of the package.\n\ne.g. `paper-input.html` or `app-toolbar/app-toolbar.html` (given that\napp-toolbar lives in the app-layout package).",
|
| 75 | "type": "string"
|
| 76 | },
|
| 77 | "privacy": {
|
| 78 | "$ref": "#/definitions/Privacy"
|
| 79 | },
|
| 80 | "properties": {
|
| 81 | "description": "The properties that this feature has.",
|
| 82 | "items": {
|
| 83 | "$ref": "#/definitions/Property"
|
| 84 | },
|
| 85 | "type": "array"
|
| 86 | },
|
| 87 | "sourceRange": {
|
| 88 | "$ref": "#/definitions/SourceRange",
|
| 89 | "description": "Where this feature is defined in source code."
|
| 90 | },
|
| 91 | "staticMethods": {
|
| 92 | "description": "The static, class-level methods that this feature has.",
|
| 93 | "items": {
|
| 94 | "$ref": "#/definitions/Method"
|
| 95 | },
|
| 96 | "type": "array"
|
| 97 | },
|
| 98 | "summary": {
|
| 99 | "description": "A markdown summary.",
|
| 100 | "type": "string"
|
| 101 | },
|
| 102 | "superclass": {
|
| 103 | "description": "The class, if any, that this class extends.",
|
| 104 | "type": "string"
|
| 105 | }
|
| 106 | },
|
| 107 | "required": [
|
| 108 | "demos",
|
| 109 | "description",
|
| 110 | "path",
|
| 111 | "privacy",
|
| 112 | "summary"
|
| 113 | ],
|
| 114 | "type": "object"
|
| 115 | },
|
| 116 | "Demo": {
|
| 117 | "properties": {
|
| 118 | "description": {
|
| 119 | "description": "A markdown description of the demo.",
|
| 120 | "type": "string"
|
| 121 | },
|
| 122 | "url": {
|
| 123 | "description": "Relative URL of the demo.",
|
| 124 | "type": "string"
|
| 125 | }
|
| 126 | },
|
| 127 | "required": [
|
| 128 | "url"
|
| 129 | ],
|
| 130 | "type": "object"
|
| 131 | },
|
| 132 | "Element": {
|
| 133 | "properties": {
|
| 134 | "attributes": {
|
| 135 | "description": "The attributes that this element is known to understand.",
|
| 136 | "items": {
|
| 137 | "$ref": "#/definitions/Attribute"
|
| 138 | },
|
| 139 | "type": "array"
|
| 140 | },
|
| 141 | "demos": {
|
| 142 | "description": "Paths, relative to the base directory of the package, to demo pages for\nthis feauture.\n\ne.g. `[{url: 'demos/index.html', description: 'How it works'}, ...]`",
|
| 143 | "items": {
|
| 144 | "$ref": "#/definitions/Demo"
|
| 145 | },
|
| 146 | "type": "array"
|
| 147 | },
|
| 148 | "description": {
|
| 149 | "description": "A markdown description.",
|
| 150 | "type": "string"
|
| 151 | },
|
| 152 | "events": {
|
| 153 | "description": "The events that this element fires.",
|
| 154 | "items": {
|
| 155 | "$ref": "#/definitions/Event"
|
| 156 | },
|
| 157 | "type": "array"
|
| 158 | },
|
| 159 | "extends": {
|
| 160 | "description": "The tagname that the element extends, if any. The value of the `extends`\noption that's passed into `customElements.define`.\n\ne.g. `input`, `paper-button`, `my-super-element`",
|
| 161 | "type": "string"
|
| 162 | },
|
| 163 | "metadata": {
|
| 164 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 165 | },
|
| 166 | "methods": {
|
| 167 | "description": "The instance methods that this feature has.",
|
| 168 | "items": {
|
| 169 | "$ref": "#/definitions/Method"
|
| 170 | },
|
| 171 | "type": "array"
|
| 172 | },
|
| 173 | "mixins": {
|
| 174 | "description": "Names of mixins applied.",
|
| 175 | "items": {
|
| 176 | "type": "string"
|
| 177 | },
|
| 178 | "type": "array"
|
| 179 | },
|
| 180 | "name": {
|
| 181 | "description": "The class name for this element.\n\ne.g. `MyElement`, `Polymer.PaperInput`",
|
| 182 | "type": "string"
|
| 183 | },
|
| 184 | "path": {
|
| 185 | "description": "The path, relative to the base directory of the package.\n\ne.g. `paper-input.html` or `app-toolbar/app-toolbar.html` (given that\napp-toolbar lives in the app-layout package).",
|
| 186 | "type": "string"
|
| 187 | },
|
| 188 | "privacy": {
|
| 189 | "$ref": "#/definitions/Privacy"
|
| 190 | },
|
| 191 | "properties": {
|
| 192 | "description": "The properties that this feature has.",
|
| 193 | "items": {
|
| 194 | "$ref": "#/definitions/Property"
|
| 195 | },
|
| 196 | "type": "array"
|
| 197 | },
|
| 198 | "slots": {
|
| 199 | "description": "The shadow dom content slots that this element accepts.",
|
| 200 | "items": {
|
| 201 | "$ref": "#/definitions/Slot"
|
| 202 | },
|
| 203 | "type": "array"
|
| 204 | },
|
| 205 | "sourceRange": {
|
| 206 | "$ref": "#/definitions/SourceRange",
|
| 207 | "description": "Where this feature is defined in source code."
|
| 208 | },
|
| 209 | "staticMethods": {
|
| 210 | "description": "The static, class-level methods that this feature has.",
|
| 211 | "items": {
|
| 212 | "$ref": "#/definitions/Method"
|
| 213 | },
|
| 214 | "type": "array"
|
| 215 | },
|
| 216 | "styling": {
|
| 217 | "description": "Information useful for styling the element and its children.",
|
| 218 | "properties": {
|
| 219 | "cssVariables": {
|
| 220 | "description": "CSS Variables that the element understands.",
|
| 221 | "items": {
|
| 222 | "properties": {
|
| 223 | "description": {
|
| 224 | "description": "A markdown description of the variable.",
|
| 225 | "type": "string"
|
| 226 | },
|
| 227 | "fallbackBehavior": {
|
| 228 | "description": "A markdown description of how the element will fallback if the variable\nisn't defined.",
|
| 229 | "type": "string"
|
| 230 | },
|
| 231 | "name": {
|
| 232 | "description": "The name of the variable. e.g. `--header-color`, `--my-element-size`",
|
| 233 | "type": "string"
|
| 234 | },
|
| 235 | "type": {
|
| 236 | "description": "The type of the variable. Advisory. e.g. `color`, `size`",
|
| 237 | "type": "string"
|
| 238 | }
|
| 239 | },
|
| 240 | "required": [
|
| 241 | "name"
|
| 242 | ],
|
| 243 | "type": "object"
|
| 244 | },
|
| 245 | "type": "array"
|
| 246 | },
|
| 247 | "needsExplicitSize": {
|
| 248 | "description": "If true, the element must be given an explicit size by its context.",
|
| 249 | "type": "boolean"
|
| 250 | },
|
| 251 | "selectors": {
|
| 252 | "description": "CSS selectors that the element recognizes on itself for styling.",
|
| 253 | "items": {
|
| 254 | "properties": {
|
| 255 | "description": {
|
| 256 | "description": "A markdown description of the effect of this selector matching\non the element.",
|
| 257 | "type": "string"
|
| 258 | },
|
| 259 | "value": {
|
| 260 | "description": "The CSS selector. e.g. `.bright`, `[height=5]`, `[cascade]`.",
|
| 261 | "type": "string"
|
| 262 | }
|
| 263 | },
|
| 264 | "required": [
|
| 265 | "description",
|
| 266 | "value"
|
| 267 | ],
|
| 268 | "type": "object"
|
| 269 | },
|
| 270 | "type": "array"
|
| 271 | }
|
| 272 | },
|
| 273 | "required": [
|
| 274 | "cssVariables",
|
| 275 | "selectors"
|
| 276 | ],
|
| 277 | "type": "object"
|
| 278 | },
|
| 279 | "summary": {
|
| 280 | "description": "A markdown summary.",
|
| 281 | "type": "string"
|
| 282 | },
|
| 283 | "superclass": {
|
| 284 | "description": "The class that this element extends.\n\nThis is non-optional, as every custom element must have HTMLElement in\nits prototype change.\n\ne.g. `HTMLElement`, `HTMLInputElement`, `MyNamespace.MyBaseElement`",
|
| 285 | "type": "string"
|
| 286 | },
|
| 287 | "tagname": {
|
| 288 | "description": "The tagname that the element registers itself as. e.g. `paper-input`",
|
| 289 | "type": "string"
|
| 290 | }
|
| 291 | },
|
| 292 | "required": [
|
| 293 | "demos",
|
| 294 | "description",
|
| 295 | "path",
|
| 296 | "privacy",
|
| 297 | "slots",
|
| 298 | "styling",
|
| 299 | "summary",
|
| 300 | "superclass"
|
| 301 | ],
|
| 302 | "type": "object"
|
| 303 | },
|
| 304 | "ElementMixin": {
|
| 305 | "properties": {
|
| 306 | "attributes": {
|
| 307 | "description": "The attributes that this element is known to understand.",
|
| 308 | "items": {
|
| 309 | "$ref": "#/definitions/Attribute"
|
| 310 | },
|
| 311 | "type": "array"
|
| 312 | },
|
| 313 | "demos": {
|
| 314 | "description": "Paths, relative to the base directory of the package, to demo pages for\nthis feauture.\n\ne.g. `[{url: 'demos/index.html', description: 'How it works'}, ...]`",
|
| 315 | "items": {
|
| 316 | "$ref": "#/definitions/Demo"
|
| 317 | },
|
| 318 | "type": "array"
|
| 319 | },
|
| 320 | "description": {
|
| 321 | "description": "A markdown description.",
|
| 322 | "type": "string"
|
| 323 | },
|
| 324 | "events": {
|
| 325 | "description": "The events that this element fires.",
|
| 326 | "items": {
|
| 327 | "$ref": "#/definitions/Event"
|
| 328 | },
|
| 329 | "type": "array"
|
| 330 | },
|
| 331 | "metadata": {
|
| 332 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 333 | },
|
| 334 | "methods": {
|
| 335 | "description": "The instance methods that this feature has.",
|
| 336 | "items": {
|
| 337 | "$ref": "#/definitions/Method"
|
| 338 | },
|
| 339 | "type": "array"
|
| 340 | },
|
| 341 | "mixins": {
|
| 342 | "description": "Names of mixins applied.",
|
| 343 | "items": {
|
| 344 | "type": "string"
|
| 345 | },
|
| 346 | "type": "array"
|
| 347 | },
|
| 348 | "name": {
|
| 349 | "description": "The name for this mixin.\n\ne.g. `MyMixin`, `Polymer.PaperInputMixin`",
|
| 350 | "type": "string"
|
| 351 | },
|
| 352 | "path": {
|
| 353 | "description": "The path, relative to the base directory of the package.\n\ne.g. `paper-input.html` or `app-toolbar/app-toolbar.html` (given that\napp-toolbar lives in the app-layout package).",
|
| 354 | "type": "string"
|
| 355 | },
|
| 356 | "privacy": {
|
| 357 | "$ref": "#/definitions/Privacy"
|
| 358 | },
|
| 359 | "properties": {
|
| 360 | "description": "The properties that this feature has.",
|
| 361 | "items": {
|
| 362 | "$ref": "#/definitions/Property"
|
| 363 | },
|
| 364 | "type": "array"
|
| 365 | },
|
| 366 | "slots": {
|
| 367 | "description": "The shadow dom content slots that this element accepts.",
|
| 368 | "items": {
|
| 369 | "$ref": "#/definitions/Slot"
|
| 370 | },
|
| 371 | "type": "array"
|
| 372 | },
|
| 373 | "sourceRange": {
|
| 374 | "$ref": "#/definitions/SourceRange",
|
| 375 | "description": "Where this feature is defined in source code."
|
| 376 | },
|
| 377 | "staticMethods": {
|
| 378 | "description": "The static, class-level methods that this feature has.",
|
| 379 | "items": {
|
| 380 | "$ref": "#/definitions/Method"
|
| 381 | },
|
| 382 | "type": "array"
|
| 383 | },
|
| 384 | "styling": {
|
| 385 | "description": "Information useful for styling the element and its children.",
|
| 386 | "properties": {
|
| 387 | "cssVariables": {
|
| 388 | "description": "CSS Variables that the element understands.",
|
| 389 | "items": {
|
| 390 | "properties": {
|
| 391 | "description": {
|
| 392 | "description": "A markdown description of the variable.",
|
| 393 | "type": "string"
|
| 394 | },
|
| 395 | "fallbackBehavior": {
|
| 396 | "description": "A markdown description of how the element will fallback if the variable\nisn't defined.",
|
| 397 | "type": "string"
|
| 398 | },
|
| 399 | "name": {
|
| 400 | "description": "The name of the variable. e.g. `--header-color`, `--my-element-size`",
|
| 401 | "type": "string"
|
| 402 | },
|
| 403 | "type": {
|
| 404 | "description": "The type of the variable. Advisory. e.g. `color`, `size`",
|
| 405 | "type": "string"
|
| 406 | }
|
| 407 | },
|
| 408 | "required": [
|
| 409 | "name"
|
| 410 | ],
|
| 411 | "type": "object"
|
| 412 | },
|
| 413 | "type": "array"
|
| 414 | },
|
| 415 | "needsExplicitSize": {
|
| 416 | "description": "If true, the element must be given an explicit size by its context.",
|
| 417 | "type": "boolean"
|
| 418 | },
|
| 419 | "selectors": {
|
| 420 | "description": "CSS selectors that the element recognizes on itself for styling.",
|
| 421 | "items": {
|
| 422 | "properties": {
|
| 423 | "description": {
|
| 424 | "description": "A markdown description of the effect of this selector matching\non the element.",
|
| 425 | "type": "string"
|
| 426 | },
|
| 427 | "value": {
|
| 428 | "description": "The CSS selector. e.g. `.bright`, `[height=5]`, `[cascade]`.",
|
| 429 | "type": "string"
|
| 430 | }
|
| 431 | },
|
| 432 | "required": [
|
| 433 | "description",
|
| 434 | "value"
|
| 435 | ],
|
| 436 | "type": "object"
|
| 437 | },
|
| 438 | "type": "array"
|
| 439 | }
|
| 440 | },
|
| 441 | "required": [
|
| 442 | "cssVariables",
|
| 443 | "selectors"
|
| 444 | ],
|
| 445 | "type": "object"
|
| 446 | },
|
| 447 | "summary": {
|
| 448 | "description": "A markdown summary.",
|
| 449 | "type": "string"
|
| 450 | },
|
| 451 | "superclass": {
|
| 452 | "description": "The class, if any, that this class extends.",
|
| 453 | "type": "string"
|
| 454 | }
|
| 455 | },
|
| 456 | "required": [
|
| 457 | "demos",
|
| 458 | "description",
|
| 459 | "name",
|
| 460 | "path",
|
| 461 | "privacy",
|
| 462 | "slots",
|
| 463 | "styling",
|
| 464 | "summary"
|
| 465 | ],
|
| 466 | "type": "object"
|
| 467 | },
|
| 468 | "Event": {
|
| 469 | "properties": {
|
| 470 | "description": {
|
| 471 | "description": "A markdown description of the event.",
|
| 472 | "type": "string"
|
| 473 | },
|
| 474 | "detail": {
|
| 475 | "description": "Information about the `detail` field of the event.",
|
| 476 | "properties": {
|
| 477 | "properties": {
|
| 478 | "items": {
|
| 479 | "$ref": "#/definitions/Property"
|
| 480 | },
|
| 481 | "type": "array"
|
| 482 | }
|
| 483 | },
|
| 484 | "required": [
|
| 485 | "properties"
|
| 486 | ],
|
| 487 | "type": "object"
|
| 488 | },
|
| 489 | "inheritedFrom": {
|
| 490 | "description": "The identifier of the class or mixin that declared this property.",
|
| 491 | "type": "string"
|
| 492 | },
|
| 493 | "metadata": {
|
| 494 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 495 | },
|
| 496 | "name": {
|
| 497 | "description": "The name of the event.",
|
| 498 | "type": "string"
|
| 499 | },
|
| 500 | "sourceRange": {
|
| 501 | "$ref": "#/definitions/SourceRange",
|
| 502 | "description": "Where this feature is defined in source code."
|
| 503 | },
|
| 504 | "type": {
|
| 505 | "description": "The type of the event object that's fired.\n\ne.g. `Event`, `CustomEvent`, `KeyboardEvent`, `MyCustomEvent`.",
|
| 506 | "type": "string"
|
| 507 | }
|
| 508 | },
|
| 509 | "required": [
|
| 510 | "description",
|
| 511 | "name",
|
| 512 | "type"
|
| 513 | ],
|
| 514 | "type": "object"
|
| 515 | },
|
| 516 | "Function": {
|
| 517 | "properties": {
|
| 518 | "description": {
|
| 519 | "description": "A markdown description for the namespace.",
|
| 520 | "type": "string"
|
| 521 | },
|
| 522 | "metadata": {
|
| 523 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 524 | },
|
| 525 | "name": {
|
| 526 | "description": "The globally accessible property-path of the namespace. e.q. `Polymer.dom`",
|
| 527 | "type": "string"
|
| 528 | },
|
| 529 | "params": {
|
| 530 | "items": {
|
| 531 | "properties": {
|
| 532 | "name": {
|
| 533 | "type": "string"
|
| 534 | },
|
| 535 | "type": {
|
| 536 | "type": "string"
|
| 537 | }
|
| 538 | },
|
| 539 | "required": [
|
| 540 | "name"
|
| 541 | ],
|
| 542 | "type": "object"
|
| 543 | },
|
| 544 | "type": "array"
|
| 545 | },
|
| 546 | "privacy": {
|
| 547 | "$ref": "#/definitions/Privacy"
|
| 548 | },
|
| 549 | "return": {
|
| 550 | "properties": {
|
| 551 | "desc": {
|
| 552 | "type": "string"
|
| 553 | },
|
| 554 | "type": {
|
| 555 | "type": "string"
|
| 556 | }
|
| 557 | },
|
| 558 | "type": "object"
|
| 559 | },
|
| 560 | "sourceRange": {
|
| 561 | "$ref": "#/definitions/SourceRange",
|
| 562 | "description": "Where this feature is defined in source code."
|
| 563 | },
|
| 564 | "summary": {
|
| 565 | "type": "string"
|
| 566 | }
|
| 567 | },
|
| 568 | "required": [
|
| 569 | "name",
|
| 570 | "privacy"
|
| 571 | ],
|
| 572 | "type": "object"
|
| 573 | },
|
| 574 | "Method": {
|
| 575 | "properties": {
|
| 576 | "description": {
|
| 577 | "description": "A markdown description of the property.",
|
| 578 | "type": "string"
|
| 579 | },
|
| 580 | "inheritedFrom": {
|
| 581 | "description": "The identifier of the class or mixin that declared this property.",
|
| 582 | "type": "string"
|
| 583 | },
|
| 584 | "metadata": {
|
| 585 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 586 | },
|
| 587 | "name": {
|
| 588 | "description": "The name of the property. e.g. `value`, `icon`, `shouldCollapse`.",
|
| 589 | "type": "string"
|
| 590 | },
|
| 591 | "params": {
|
| 592 | "description": "An array of data objects describing the method signature. This data may be\nincomplete. For example, only argument names can be detected from an\nundocumented JavaScript function. Argument types can only be read from\nassociated JSDoc via @param tags",
|
| 593 | "items": {
|
| 594 | "$ref": "#/definitions/Parameter"
|
| 595 | },
|
| 596 | "type": "array"
|
| 597 | },
|
| 598 | "privacy": {
|
| 599 | "$ref": "#/definitions/Privacy"
|
| 600 | },
|
| 601 | "return": {
|
| 602 | "description": "Data describing the method return type. This data may be incomplete.\nFor example, the return type can be detected from a documented JavaScript\nfunction with associated JSDoc and a @return tag.",
|
| 603 | "properties": {
|
| 604 | "desc": {
|
| 605 | "type": "string"
|
| 606 | },
|
| 607 | "type": {
|
| 608 | "type": "string"
|
| 609 | }
|
| 610 | },
|
| 611 | "type": "object"
|
| 612 | },
|
| 613 | "sourceRange": {
|
| 614 | "$ref": "#/definitions/SourceRange",
|
| 615 | "description": "Where this feature is defined in source code."
|
| 616 | }
|
| 617 | },
|
| 618 | "required": [
|
| 619 | "description",
|
| 620 | "name",
|
| 621 | "privacy"
|
| 622 | ],
|
| 623 | "type": "object"
|
| 624 | },
|
| 625 | "Namespace": {
|
| 626 | "properties": {
|
| 627 | "classes": {
|
| 628 | "items": {
|
| 629 | "$ref": "#/definitions/Class"
|
| 630 | },
|
| 631 | "type": "array"
|
| 632 | },
|
| 633 | "description": {
|
| 634 | "description": "A markdown description for the namespace.",
|
| 635 | "type": "string"
|
| 636 | },
|
| 637 | "elements": {
|
| 638 | "items": {
|
| 639 | "$ref": "#/definitions/Element"
|
| 640 | },
|
| 641 | "type": "array"
|
| 642 | },
|
| 643 | "functions": {
|
| 644 | "items": {
|
| 645 | "$ref": "#/definitions/Function"
|
| 646 | },
|
| 647 | "type": "array"
|
| 648 | },
|
| 649 | "metadata": {
|
| 650 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 651 | },
|
| 652 | "mixins": {
|
| 653 | "items": {
|
| 654 | "$ref": "#/definitions/ElementMixin"
|
| 655 | },
|
| 656 | "type": "array"
|
| 657 | },
|
| 658 | "name": {
|
| 659 | "description": "The globally accessible property-path of the namespace. e.q. `Polymer.dom`",
|
| 660 | "type": "string"
|
| 661 | },
|
| 662 | "namespaces": {
|
| 663 | "items": {
|
| 664 | "$ref": "#/definitions/Namespace"
|
| 665 | },
|
| 666 | "type": "array"
|
| 667 | },
|
| 668 | "sourceRange": {
|
| 669 | "$ref": "#/definitions/SourceRange",
|
| 670 | "description": "Where this feature is defined in source code."
|
| 671 | },
|
| 672 | "summary": {
|
| 673 | "description": "A markdown summary for the namespace.",
|
| 674 | "type": "string"
|
| 675 | }
|
| 676 | },
|
| 677 | "required": [
|
| 678 | "name"
|
| 679 | ],
|
| 680 | "type": "object"
|
| 681 | },
|
| 682 | "Parameter": {
|
| 683 | "properties": {
|
| 684 | "description": {
|
| 685 | "type": "string"
|
| 686 | },
|
| 687 | "name": {
|
| 688 | "type": "string"
|
| 689 | },
|
| 690 | "type": {
|
| 691 | "type": "string"
|
| 692 | }
|
| 693 | },
|
| 694 | "required": [
|
| 695 | "name"
|
| 696 | ],
|
| 697 | "type": "object"
|
| 698 | },
|
| 699 | "Position": {
|
| 700 | "properties": {
|
| 701 | "column": {
|
| 702 | "description": "Column offset within the line, starting from zero.",
|
| 703 | "type": "number"
|
| 704 | },
|
| 705 | "line": {
|
| 706 | "description": "Line number, starting from zero.",
|
| 707 | "type": "number"
|
| 708 | }
|
| 709 | },
|
| 710 | "required": [
|
| 711 | "column",
|
| 712 | "line"
|
| 713 | ],
|
| 714 | "type": "object"
|
| 715 | },
|
| 716 | "Privacy": {
|
| 717 | "enum": [
|
| 718 | "private",
|
| 719 | "protected",
|
| 720 | "public"
|
| 721 | ],
|
| 722 | "type": "string"
|
| 723 | },
|
| 724 | "Property": {
|
| 725 | "properties": {
|
| 726 | "defaultValue": {
|
| 727 | "description": "A string representation of the default value. Intended only to be human\nreadable, so may be a description, an identifier name, etc.",
|
| 728 | "type": "string"
|
| 729 | },
|
| 730 | "description": {
|
| 731 | "description": "A markdown description of the property.",
|
| 732 | "type": "string"
|
| 733 | },
|
| 734 | "inheritedFrom": {
|
| 735 | "description": "The identifier of the class or mixin that declared this property.",
|
| 736 | "type": "string"
|
| 737 | },
|
| 738 | "metadata": {
|
| 739 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 740 | },
|
| 741 | "name": {
|
| 742 | "description": "The name of the property. e.g. `value`, `icon`, `shouldCollapse`.",
|
| 743 | "type": "string"
|
| 744 | },
|
| 745 | "privacy": {
|
| 746 | "$ref": "#/definitions/Privacy"
|
| 747 | },
|
| 748 | "properties": {
|
| 749 | "description": "Nested subproperties hanging off of this property.",
|
| 750 | "items": {
|
| 751 | "$ref": "#/definitions/Property"
|
| 752 | },
|
| 753 | "type": "array"
|
| 754 | },
|
| 755 | "sourceRange": {
|
| 756 | "$ref": "#/definitions/SourceRange",
|
| 757 | "description": "Where this feature is defined in source code."
|
| 758 | },
|
| 759 | "type": {
|
| 760 | "description": "The javascript type of the property.\n\nThere's no standard here. Common choices are closure compiler syntax\nand typescript syntax.",
|
| 761 | "type": "string"
|
| 762 | }
|
| 763 | },
|
| 764 | "required": [
|
| 765 | "description",
|
| 766 | "name",
|
| 767 | "privacy",
|
| 768 | "type"
|
| 769 | ],
|
| 770 | "type": "object"
|
| 771 | },
|
| 772 | "Slot": {
|
| 773 | "properties": {
|
| 774 | "description": {
|
| 775 | "description": "A markdown description of the slot.",
|
| 776 | "type": "string"
|
| 777 | },
|
| 778 | "metadata": {
|
| 779 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the element was written in,\ntags/categories, links to specs that the element implements, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 780 | },
|
| 781 | "name": {
|
| 782 | "description": "The name of the slot. e.g. `banner`, `body`, `tooltipContents`",
|
| 783 | "type": "string"
|
| 784 | },
|
| 785 | "sourceRange": {
|
| 786 | "$ref": "#/definitions/SourceRange",
|
| 787 | "description": "Where this feature is defined in source code."
|
| 788 | }
|
| 789 | },
|
| 790 | "required": [
|
| 791 | "description",
|
| 792 | "name"
|
| 793 | ],
|
| 794 | "type": "object"
|
| 795 | },
|
| 796 | "SourceRange": {
|
| 797 | "properties": {
|
| 798 | "end": {
|
| 799 | "$ref": "#/definitions/Position"
|
| 800 | },
|
| 801 | "file": {
|
| 802 | "description": "Path to the file containing the definition of the feature,\nrelative to the parent feature, or the package if the feature has no parent\n(e.g. elements).\n\nIf blank, the feature is defined in the same file as its parent.",
|
| 803 | "type": "string"
|
| 804 | },
|
| 805 | "start": {
|
| 806 | "$ref": "#/definitions/Position"
|
| 807 | }
|
| 808 | },
|
| 809 | "required": [
|
| 810 | "end",
|
| 811 | "start"
|
| 812 | ],
|
| 813 | "type": "object"
|
| 814 | }
|
| 815 | },
|
| 816 | "description": "The global namespace of features contained in an analysis.\n\nTop-level members are unnamespaced, everything else is contained\nin a namespace. Often an analysis will contain only one namespace at\nthe root.",
|
| 817 | "properties": {
|
| 818 | "classes": {
|
| 819 | "description": "All toplevel classes found that were not covered by one of the other types.\n\ne.g. classes that are elements are only found in `elements`",
|
| 820 | "items": {
|
| 821 | "$ref": "#/definitions/Class"
|
| 822 | },
|
| 823 | "type": "array"
|
| 824 | },
|
| 825 | "elements": {
|
| 826 | "description": "All elements found.",
|
| 827 | "items": {
|
| 828 | "$ref": "#/definitions/Element"
|
| 829 | },
|
| 830 | "type": "array"
|
| 831 | },
|
| 832 | "functions": {
|
| 833 | "description": "All toplevel functions found.",
|
| 834 | "items": {
|
| 835 | "$ref": "#/definitions/Function"
|
| 836 | },
|
| 837 | "type": "array"
|
| 838 | },
|
| 839 | "metadata": {
|
| 840 | "description": "An extension point for framework-specific metadata, as well as any\nmetadata not yet standardized here such as what polyfills are needed,\nbehaviors and mixins used, the framework that the package was written in,\ntags/categories, framework config files, etc.\n\nFramework-specific metadata should be put into a sub-object with the name\nof that framework."
|
| 841 | },
|
| 842 | "mixins": {
|
| 843 | "description": "All element mixins found.",
|
| 844 | "items": {
|
| 845 | "$ref": "#/definitions/ElementMixin"
|
| 846 | },
|
| 847 | "type": "array"
|
| 848 | },
|
| 849 | "namespaces": {
|
| 850 | "description": "All toplevel namespaces found.",
|
| 851 | "items": {
|
| 852 | "$ref": "#/definitions/Namespace"
|
| 853 | },
|
| 854 | "type": "array"
|
| 855 | },
|
| 856 | "schema_version": {
|
| 857 | "type": "string"
|
| 858 | }
|
| 859 | },
|
| 860 | "required": [
|
| 861 | "schema_version"
|
| 862 | ],
|
| 863 | "type": "object"
|
| 864 | }
|
| 865 |
|