| 1 | title: 'Graph protocol'
|
| 2 | description: 'This protocol is utilized for communicating about graph changes in both directions.'
|
| 3 |
|
| 4 | output:
|
| 5 | error:
|
| 6 | description: 'Graph error'
|
| 7 |
|
| 8 | addnode:
|
| 9 | description: 'Add node to a graph.'
|
| 10 | properties:
|
| 11 | id:
|
| 12 | type: string
|
| 13 | description: 'identifier for the node'
|
| 14 | required: true
|
| 15 | component:
|
| 16 | type: string
|
| 17 | description: 'component name used for the node'
|
| 18 | required: true
|
| 19 | metadata:
|
| 20 | type: object
|
| 21 | description: '(optional): structure of key-value pairs for node metadata'
|
| 22 | graph:
|
| 23 | type: string
|
| 24 | description: 'graph the action targets'
|
| 25 | required: true
|
| 26 |
|
| 27 | removenode:
|
| 28 | description: 'Remove a node from a graph.'
|
| 29 | properties:
|
| 30 | id:
|
| 31 | type: string
|
| 32 | description: 'identifier for the node'
|
| 33 | required: true
|
| 34 | graph:
|
| 35 | type: string
|
| 36 | description: 'graph the action targets'
|
| 37 | required: true
|
| 38 |
|
| 39 | renamenode:
|
| 40 | description: 'Change the ID of a node in the graph'
|
| 41 | properties:
|
| 42 | from:
|
| 43 | type: string
|
| 44 | description: 'original identifier for the node'
|
| 45 | required: true
|
| 46 | to:
|
| 47 | type: string
|
| 48 | description: 'new identifier for the node'
|
| 49 | required: true
|
| 50 | graph:
|
| 51 | type: string
|
| 52 | description: 'graph the action targets'
|
| 53 | required: true
|
| 54 |
|
| 55 | changenode:
|
| 56 | description: 'Change the metadata associated to a node in the graph'
|
| 57 | properties:
|
| 58 | id:
|
| 59 | type: string
|
| 60 | description: 'identifier for the node'
|
| 61 | required: true
|
| 62 | metadata:
|
| 63 | type: object
|
| 64 | description: 'structure of key-value pairs for node metadata'
|
| 65 | required: true
|
| 66 | graph:
|
| 67 | type: string
|
| 68 | description: 'graph the action targets'
|
| 69 | required: true
|
| 70 |
|
| 71 | addedge:
|
| 72 | description: 'Add an edge to the graph'
|
| 73 | properties:
|
| 74 | src:
|
| 75 | type: object
|
| 76 | description: 'source node for the edge'
|
| 77 | required: true
|
| 78 | properties:
|
| 79 | node:
|
| 80 | type: string
|
| 81 | description: 'node identifier'
|
| 82 | required: true
|
| 83 | port:
|
| 84 | type: string
|
| 85 | description: 'port name'
|
| 86 | required: true
|
| 87 | index:
|
| 88 | type: ["string", "number"]
|
| 89 | description: 'connection index (optional, for addressable ports)'
|
| 90 | tgt:
|
| 91 | type: object
|
| 92 | description: 'target node for the edge'
|
| 93 | required: true
|
| 94 | properties:
|
| 95 | node:
|
| 96 | type: string
|
| 97 | description: 'node identifier'
|
| 98 | required: true
|
| 99 | port:
|
| 100 | type: string
|
| 101 | description: 'port name'
|
| 102 | required: true
|
| 103 | index:
|
| 104 | type: string
|
| 105 | description: 'connection index (optional, for addressable ports)'
|
| 106 | metadata:
|
| 107 | type: object
|
| 108 | description: '(optional): structure of key-value pairs for edge metadata'
|
| 109 | graph:
|
| 110 | description: 'graph the action targets'
|
| 111 | required: true
|
| 112 |
|
| 113 | removeedge:
|
| 114 | description: 'Remove an edge from the graph'
|
| 115 | properties:
|
| 116 | graph:
|
| 117 | type: string
|
| 118 | description: 'graph the action targets'
|
| 119 | required: true
|
| 120 | src:
|
| 121 | description: 'source node for the edge'
|
| 122 | required: true
|
| 123 | properties:
|
| 124 | node:
|
| 125 | type: string
|
| 126 | description: 'node identifier'
|
| 127 | port:
|
| 128 | type: string
|
| 129 | description: 'port name'
|
| 130 | tgt:
|
| 131 | description: 'target node for the edge'
|
| 132 | required: true
|
| 133 | properties:
|
| 134 | node:
|
| 135 | type: string
|
| 136 | description: 'node identifier'
|
| 137 | port:
|
| 138 | type: string
|
| 139 | description: 'port name'
|
| 140 |
|
| 141 | changeedge:
|
| 142 | description: 'Change an edge''s metadata'
|
| 143 | properties:
|
| 144 | graph:
|
| 145 | type: string
|
| 146 | description: 'graph the action targets'
|
| 147 | required: true
|
| 148 | metadata:
|
| 149 | type: object
|
| 150 | description: 'struct of key-value pairs for edge metadata'
|
| 151 | src:
|
| 152 | type: object
|
| 153 | description: 'source node for the edge'
|
| 154 | properties:
|
| 155 | node:
|
| 156 | type: string
|
| 157 | description: 'node identifier'
|
| 158 | port:
|
| 159 | type: string
|
| 160 | description: 'port name'
|
| 161 | tgt:
|
| 162 | type: object
|
| 163 | description: 'target node for the edge'
|
| 164 | properties:
|
| 165 | node:
|
| 166 | type: string
|
| 167 | description: 'node identifier'
|
| 168 | port:
|
| 169 | type: string
|
| 170 | description: 'port name'
|
| 171 |
|
| 172 | addinitial:
|
| 173 | description: 'Add an IIP to the graph'
|
| 174 | properties:
|
| 175 | graph:
|
| 176 | type: string
|
| 177 | description: 'graph the action targets'
|
| 178 | metadata:
|
| 179 | type: object
|
| 180 | description: '(optional): structure of key-value pairs for edge metadata'
|
| 181 | src:
|
| 182 | type: object
|
| 183 | properties:
|
| 184 | data:
|
| 185 | type: any
|
| 186 | description: 'IIP value in its actual data type'
|
| 187 | tgt:
|
| 188 | type: object
|
| 189 | description: 'target node for the edge'
|
| 190 | properties:
|
| 191 | node:
|
| 192 | type: string
|
| 193 | description: 'node identifier'
|
| 194 | port:
|
| 195 | type: string
|
| 196 | description: 'port name'
|
| 197 | index:
|
| 198 | type: ["string", "number"]
|
| 199 | description: 'connection index (optional, for addressable ports)'
|
| 200 |
|
| 201 | removeinitial:
|
| 202 | description: 'Remove an IIP from the graph'
|
| 203 | properties:
|
| 204 | tgt:
|
| 205 | type: object
|
| 206 | properties:
|
| 207 | node:
|
| 208 | type: string
|
| 209 | description: 'node identifier'
|
| 210 | port:
|
| 211 | type: string
|
| 212 | description: 'port name'
|
| 213 | description: 'target node for the edge'
|
| 214 | graph:
|
| 215 | type: string
|
| 216 | description: 'graph the action targets'
|
| 217 |
|
| 218 | addinport:
|
| 219 | description: 'Add an exported inport to the graph.'
|
| 220 | properties:
|
| 221 | public:
|
| 222 | type: string
|
| 223 | description: 'the exported name of the port'
|
| 224 | node:
|
| 225 | type: string
|
| 226 | description: 'node identifier'
|
| 227 | port:
|
| 228 | type: string
|
| 229 | description: 'internal port name'
|
| 230 | metadata:
|
| 231 | type: object
|
| 232 | description: '(optional): structure of key-value pairs for node metadata'
|
| 233 | graph:
|
| 234 | type: string
|
| 235 | description: 'graph the action targets'
|
| 236 |
|
| 237 | removeinport:
|
| 238 | description: 'Remove an exported port from the graph'
|
| 239 | properties:
|
| 240 | public:
|
| 241 | type: string
|
| 242 | description: 'the exported name of the port to remove'
|
| 243 | graph:
|
| 244 | type: string
|
| 245 | description: 'graph the action targets'
|
| 246 |
|
| 247 | renameinport:
|
| 248 | description: 'Rename an exported port in the graph'
|
| 249 | properties:
|
| 250 | from:
|
| 251 | type: string
|
| 252 | description: 'original exported port name'
|
| 253 | to:
|
| 254 | type: string
|
| 255 | description: 'new exported port name'
|
| 256 | graph:
|
| 257 | type: string
|
| 258 | description: 'graph the action targets'
|
| 259 |
|
| 260 | addoutport:
|
| 261 | description: 'Add an exported outport to the graph.'
|
| 262 | properties:
|
| 263 | public:
|
| 264 | type: string
|
| 265 | description: 'the exported name of the port'
|
| 266 | node:
|
| 267 | type: string
|
| 268 | description: 'node identifier'
|
| 269 | port:
|
| 270 | type: string
|
| 271 | description: 'internal port name'
|
| 272 | metadata:
|
| 273 | type: object
|
| 274 | description: '(optional): structure of key-value pairs for port metadata'
|
| 275 | graph:
|
| 276 | type: string
|
| 277 | description: 'graph the action targets'
|
| 278 |
|
| 279 | removeoutport:
|
| 280 | description: 'Remove an exported port from the graph'
|
| 281 | properties:
|
| 282 | public:
|
| 283 | type: string
|
| 284 | description: 'the exported name of the port to remove'
|
| 285 | graph:
|
| 286 | type: string
|
| 287 | description: 'graph the action targets'
|
| 288 |
|
| 289 | renameoutport:
|
| 290 | description: 'Rename an exported port in the graph'
|
| 291 | properties:
|
| 292 | from:
|
| 293 | type: string
|
| 294 | description: 'original exported port name'
|
| 295 | to:
|
| 296 | type: string
|
| 297 | description: 'new exported port name'
|
| 298 | graph:
|
| 299 | type: string
|
| 300 | description: 'graph the action targets'
|
| 301 |
|
| 302 | addgroup:
|
| 303 | description: 'Add a group to the graph'
|
| 304 | properties:
|
| 305 | name:
|
| 306 | type: string
|
| 307 | description: 'the group name'
|
| 308 | nodes:
|
| 309 | type: array
|
| 310 | description: 'an array of node ids part of the group'
|
| 311 | metadata:
|
| 312 | type: object
|
| 313 | description: '(optional): structure of key-value pairs for group metadata'
|
| 314 | graph:
|
| 315 | type: string
|
| 316 | description: 'graph the action targets'
|
| 317 |
|
| 318 | removegroup:
|
| 319 | description: 'Remove a group from the graph'
|
| 320 | properties:
|
| 321 | name:
|
| 322 | type: string
|
| 323 | description: 'the group name'
|
| 324 | graph:
|
| 325 | type: string
|
| 326 | description: 'graph the action targets'
|
| 327 |
|
| 328 | renamegroup:
|
| 329 | description: 'Rename a group in the graph.'
|
| 330 | properties:
|
| 331 | from:
|
| 332 | type: string
|
| 333 | description: 'original group name'
|
| 334 | to:
|
| 335 | type: string
|
| 336 | description: 'new group name'
|
| 337 | graph:
|
| 338 | type: string
|
| 339 | description: 'graph the action targets'
|
| 340 |
|
| 341 | changegroup:
|
| 342 | description: 'Change a group''s metadata'
|
| 343 | properties:
|
| 344 | name:
|
| 345 | type: string
|
| 346 | description: 'the group name'
|
| 347 | required: true
|
| 348 | metadata:
|
| 349 | type: object
|
| 350 | description: 'structure of key-value pairs for group metadata'
|
| 351 | graph:
|
| 352 | type: string
|
| 353 | description: 'graph the action targets'
|
| 354 | required: true
|
| 355 |
|
| 356 | input:
|
| 357 | error:
|
| 358 | description: 'Graph error'
|
| 359 |
|
| 360 | clear:
|
| 361 | description: 'Initialize an empty graph.'
|
| 362 | properties:
|
| 363 | id:
|
| 364 | type: string
|
| 365 | description: 'identifier for the graph being created. Used for all subsequent messages related to the graph instance'
|
| 366 | required: true
|
| 367 | name:
|
| 368 | type: string
|
| 369 | description: '(optional) Human-readable label for the graph'
|
| 370 | library:
|
| 371 | type: string
|
| 372 | description: '(optional) Component library identifier'
|
| 373 | main:
|
| 374 | type: boolean
|
| 375 | description: "(optional) Identifies the graph as a main graph of a project that should not be registered as a component\nGraphs registered in this way should also be available for use as subgraphs in other graphs. Therefore a graph registration and later changes to it may cause component messages of the Component protocol to be sent back to the client informing of possible changes in the ports of the subgraph component."
|
| 376 |
|
| 377 | addnode:
|
| 378 | description: 'Add node to a graph.'
|
| 379 | properties:
|
| 380 | id:
|
| 381 | type: string
|
| 382 | description: 'identifier for the node'
|
| 383 | required: true
|
| 384 | component:
|
| 385 | type: string
|
| 386 | description: 'component name used for the node'
|
| 387 | required: true
|
| 388 | metadata:
|
| 389 | type: object
|
| 390 | description: '(optional): structure of key-value pairs for node metadata'
|
| 391 | graph:
|
| 392 | type: string
|
| 393 | description: 'graph the action targets'
|
| 394 | required: true
|
| 395 |
|
| 396 | removenode:
|
| 397 | description: 'Remove a node from a graph.'
|
| 398 | properties:
|
| 399 | id:
|
| 400 | type: string
|
| 401 | description: 'identifier for the node'
|
| 402 | required: true
|
| 403 | graph:
|
| 404 | type: string
|
| 405 | description: 'graph the action targets'
|
| 406 | required: true
|
| 407 |
|
| 408 | renamenode:
|
| 409 | description: 'Change the ID of a node in the graph'
|
| 410 | properties:
|
| 411 | from:
|
| 412 | type: string
|
| 413 | description: 'original identifier for the node'
|
| 414 | required: true
|
| 415 | to:
|
| 416 | type: string
|
| 417 | description: 'new identifier for the node'
|
| 418 | required: true
|
| 419 | graph:
|
| 420 | type: string
|
| 421 | description: 'graph the action targets'
|
| 422 | required: true
|
| 423 |
|
| 424 | changenode:
|
| 425 | description: 'Change the metadata associated to a node in the graph'
|
| 426 | properties:
|
| 427 | id:
|
| 428 | type: string
|
| 429 | description: 'identifier for the node'
|
| 430 | required: true
|
| 431 | metadata:
|
| 432 | type: object
|
| 433 | description: 'structure of key-value pairs for node metadata'
|
| 434 | required: true
|
| 435 | graph:
|
| 436 | type: string
|
| 437 | description: 'graph the action targets'
|
| 438 | required: true
|
| 439 |
|
| 440 | addedge:
|
| 441 | description: 'Add an edge to the graph'
|
| 442 | properties:
|
| 443 | src:
|
| 444 | type: object
|
| 445 | description: 'source node for the edge'
|
| 446 | properties:
|
| 447 | node:
|
| 448 | type: string
|
| 449 | description: 'node identifier'
|
| 450 | port:
|
| 451 | type: string
|
| 452 | description: 'port name'
|
| 453 | index:
|
| 454 | type: ["string", "number"]
|
| 455 | description: 'connection index (optional, for addressable ports)'
|
| 456 | tgt:
|
| 457 | type: object
|
| 458 | description: 'target node for the edge'
|
| 459 | properties:
|
| 460 | node:
|
| 461 | type: string
|
| 462 | description: 'node identifier'
|
| 463 | port:
|
| 464 | type: string
|
| 465 | description: 'port name'
|
| 466 | index:
|
| 467 | type: ["string", "number"]
|
| 468 | description: 'connection index (optional, for addressable ports)'
|
| 469 | metadata:
|
| 470 | type: object
|
| 471 | description: '(optional): structure of key-value pairs for edge metadata'
|
| 472 | graph:
|
| 473 | description: 'graph the action targets'
|
| 474 |
|
| 475 | removeedge:
|
| 476 | description: 'Remove an edge from the graph'
|
| 477 | properties:
|
| 478 | graph:
|
| 479 | type: string
|
| 480 | description: 'graph the action targets'
|
| 481 | src:
|
| 482 | type: object
|
| 483 | description: 'source node for the edge'
|
| 484 | properties:
|
| 485 | node:
|
| 486 | type: string
|
| 487 | description: 'node identifier'
|
| 488 | port:
|
| 489 | type: string
|
| 490 | description: 'port name'
|
| 491 | tgt:
|
| 492 | type: object
|
| 493 | description: 'target node for the edge'
|
| 494 | properties:
|
| 495 | node:
|
| 496 | type: string
|
| 497 | description: 'node identifier'
|
| 498 | port:
|
| 499 | type: string
|
| 500 | description: 'port name'
|
| 501 |
|
| 502 | changeedge:
|
| 503 | description: 'Change an edge''s metadata'
|
| 504 | properties:
|
| 505 | graph:
|
| 506 | type: string
|
| 507 | description: 'graph the action targets'
|
| 508 | metadata:
|
| 509 | type: object
|
| 510 | description: 'struct of key-value pairs for edge metadata'
|
| 511 | src:
|
| 512 | type: object
|
| 513 | description: 'source node for the edge'
|
| 514 | properties:
|
| 515 | node:
|
| 516 | type: string
|
| 517 | description: 'node identifier'
|
| 518 | port:
|
| 519 | type: string
|
| 520 | description: 'port name'
|
| 521 | tgt:
|
| 522 | type: object
|
| 523 | description: 'target node for the edge'
|
| 524 | properties:
|
| 525 | node:
|
| 526 | type: string
|
| 527 | description: 'node identifier'
|
| 528 | port:
|
| 529 | type: string
|
| 530 | description: 'port name'
|
| 531 |
|
| 532 | addinitial:
|
| 533 | description: 'Add an IIP to the graph'
|
| 534 | properties:
|
| 535 | graph:
|
| 536 | type: string
|
| 537 | description: 'graph the action targets'
|
| 538 | metadata:
|
| 539 | type: object
|
| 540 | description: '(optional): structure of key-value pairs for edge metadata'
|
| 541 | src:
|
| 542 | type: object
|
| 543 | properties:
|
| 544 | data:
|
| 545 | type: any
|
| 546 | description: 'IIP value in its actual data type'
|
| 547 | tgt:
|
| 548 | type: object
|
| 549 | description: 'target node for the edge'
|
| 550 | properties:
|
| 551 | node:
|
| 552 | type: string
|
| 553 | description: 'node identifier'
|
| 554 | port:
|
| 555 | type: string
|
| 556 | description: 'port name'
|
| 557 | index:
|
| 558 | type: ["string", "number"]
|
| 559 | description: 'connection index (optional, for addressable ports)'
|
| 560 |
|
| 561 | removeinitial:
|
| 562 | description: 'Remove an IIP from the graph'
|
| 563 | properties:
|
| 564 | tgt:
|
| 565 | type: object
|
| 566 | properties:
|
| 567 | node:
|
| 568 | type: string
|
| 569 | description: 'node identifier'
|
| 570 | port:
|
| 571 | type: string
|
| 572 | description: 'port name'
|
| 573 | description: 'target node for the edge'
|
| 574 | graph:
|
| 575 | type: string
|
| 576 | description: 'graph the action targets'
|
| 577 |
|
| 578 | addinport:
|
| 579 | description: 'Add an exported inport to the graph.'
|
| 580 | properties:
|
| 581 | public:
|
| 582 | type: string
|
| 583 | description: 'the exported name of the port'
|
| 584 | node:
|
| 585 | type: string
|
| 586 | description: 'node identifier'
|
| 587 | port:
|
| 588 | type: string
|
| 589 | description: 'internal port name'
|
| 590 | metadata:
|
| 591 | type: object
|
| 592 | description: '(optional): structure of key-value pairs for node metadata'
|
| 593 | graph:
|
| 594 | type: string
|
| 595 | description: 'graph the action targets'
|
| 596 |
|
| 597 | removeinport:
|
| 598 | description: 'Remove an exported port from the graph'
|
| 599 | properties:
|
| 600 | public:
|
| 601 | type: string
|
| 602 | description: 'the exported name of the port to remove'
|
| 603 | graph:
|
| 604 | type: string
|
| 605 | description: 'graph the action targets'
|
| 606 |
|
| 607 | renameinport:
|
| 608 | description: 'Rename an exported port in the graph'
|
| 609 | properties:
|
| 610 | from:
|
| 611 | type: string
|
| 612 | description: 'original exported port name'
|
| 613 | to:
|
| 614 | type: string
|
| 615 | description: 'new exported port name'
|
| 616 | graph:
|
| 617 | type: string
|
| 618 | description: 'graph the action targets'
|
| 619 |
|
| 620 | addoutport:
|
| 621 | description: 'Add an exported outport to the graph.'
|
| 622 | properties:
|
| 623 | public:
|
| 624 | type: string
|
| 625 | description: 'the exported name of the port'
|
| 626 | node:
|
| 627 | type: string
|
| 628 | description: 'node identifier'
|
| 629 | port:
|
| 630 | type: string
|
| 631 | description: 'internal port name'
|
| 632 | metadata:
|
| 633 | type: object
|
| 634 | description: '(optional): structure of key-value pairs for port metadata'
|
| 635 | graph:
|
| 636 | type: string
|
| 637 | description: 'graph the action targets'
|
| 638 |
|
| 639 | removeoutport:
|
| 640 | description: 'Remove an exported port from the graph'
|
| 641 | properties:
|
| 642 | public:
|
| 643 | type: string
|
| 644 | description: 'the exported name of the port to remove'
|
| 645 | graph:
|
| 646 | type: string
|
| 647 | description: 'graph the action targets'
|
| 648 |
|
| 649 | renameoutport:
|
| 650 | description: 'Rename an exported port in the graph'
|
| 651 | properties:
|
| 652 | from:
|
| 653 | type: string
|
| 654 | description: 'original exported port name'
|
| 655 | to:
|
| 656 | type: string
|
| 657 | description: 'new exported port name'
|
| 658 | graph:
|
| 659 | type: string
|
| 660 | description: 'graph the action targets'
|
| 661 |
|
| 662 | addgroup:
|
| 663 | description: 'Add a group to the graph'
|
| 664 | properties:
|
| 665 | name:
|
| 666 | type: string
|
| 667 | description: 'the group name'
|
| 668 | nodes:
|
| 669 | type: array
|
| 670 | description: 'an array of node ids part of the group'
|
| 671 | metadata:
|
| 672 | type: object
|
| 673 | description: '(optional): structure of key-value pairs for group metadata'
|
| 674 | graph:
|
| 675 | type: string
|
| 676 | description: 'graph the action targets'
|
| 677 |
|
| 678 | removegroup:
|
| 679 | description: 'Remove a group from the graph'
|
| 680 | properties:
|
| 681 | name:
|
| 682 | type: string
|
| 683 | description: 'the group name'
|
| 684 | graph:
|
| 685 | type: string
|
| 686 | description: 'graph the action targets'
|
| 687 |
|
| 688 | renamegroup:
|
| 689 | description: 'Rename a group in the graph.'
|
| 690 | properties:
|
| 691 | from:
|
| 692 | type: string
|
| 693 | description: 'original group name'
|
| 694 | to:
|
| 695 | type: string
|
| 696 | description: 'new group name'
|
| 697 | graph:
|
| 698 | type: string
|
| 699 | description: 'graph the action targets'
|
| 700 |
|
| 701 | changegroup:
|
| 702 | description: 'Change a group''s metadata'
|
| 703 | properties:
|
| 704 | name:
|
| 705 | type: string
|
| 706 | description: 'the group name'
|
| 707 | metadata:
|
| 708 | type: object
|
| 709 | description: 'structure of key-value pairs for group metadata'
|
| 710 | graph:
|
| 711 | type: string
|
| 712 | description: 'graph the action targets'
|