|
61 | 61 | content:
|
62 | 62 | application/json:
|
63 | 63 | schema:
|
64 |
| - $ref: '#/components/schemas/StreamRead' |
| 64 | + $ref: '#/components/schemas/StreamReadResponse' |
65 | 65 | '422':
|
66 | 66 | description: Validation Error
|
67 | 67 | content:
|
@@ -159,12 +159,13 @@ paths:
|
159 | 159 | tags:
|
160 | 160 | - manifest
|
161 | 161 | summary: Full Resolve
|
162 |
| - description: 'Fully resolve a manifest including dynamic streams. |
| 162 | + description: 'Fully resolve a manifest, including dynamic streams. |
163 | 163 |
|
164 | 164 |
|
165 |
| - Generates dynamic streams up to the specified limit and includes |
166 |
| -
|
167 |
| - them in the resolved manifest.' |
| 165 | + This is a similar operation to resolve, but has an extra step which generates |
| 166 | + streams from dynamic stream templates if the manifest contains any. This is |
| 167 | + used when a user clicks the generate streams button on a stream template in |
| 168 | + the Builder UI' |
168 | 169 | operationId: fullResolve
|
169 | 170 | requestBody:
|
170 | 171 | content:
|
@@ -465,7 +466,26 @@ components:
|
465 | 466 | - manifest
|
466 | 467 | title: ResolveRequest
|
467 | 468 | description: Request to resolve a manifest.
|
468 |
| - StreamRead: |
| 469 | + StreamReadPages: |
| 470 | + properties: |
| 471 | + records: |
| 472 | + items: {} |
| 473 | + type: array |
| 474 | + title: Records |
| 475 | + request: |
| 476 | + anyOf: |
| 477 | + - $ref: '#/components/schemas/HttpRequest' |
| 478 | + - type: 'null' |
| 479 | + response: |
| 480 | + anyOf: |
| 481 | + - $ref: '#/components/schemas/HttpResponse' |
| 482 | + - type: 'null' |
| 483 | + type: object |
| 484 | + required: |
| 485 | + - records |
| 486 | + title: StreamReadPages |
| 487 | + description: Pages of data read from a stream slice. |
| 488 | + StreamReadResponse: |
469 | 489 | properties:
|
470 | 490 | logs:
|
471 | 491 | items:
|
@@ -511,27 +531,8 @@ components:
|
511 | 531 | - inferred_schema
|
512 | 532 | - inferred_datetime_formats
|
513 | 533 | - latest_config_update
|
514 |
| - title: StreamRead |
| 534 | + title: StreamReadResponse |
515 | 535 | description: Complete stream read response with properly typed fields.
|
516 |
| - StreamReadPages: |
517 |
| - properties: |
518 |
| - records: |
519 |
| - items: {} |
520 |
| - type: array |
521 |
| - title: Records |
522 |
| - request: |
523 |
| - anyOf: |
524 |
| - - $ref: '#/components/schemas/HttpRequest' |
525 |
| - - type: 'null' |
526 |
| - response: |
527 |
| - anyOf: |
528 |
| - - $ref: '#/components/schemas/HttpResponse' |
529 |
| - - type: 'null' |
530 |
| - type: object |
531 |
| - required: |
532 |
| - - records |
533 |
| - title: StreamReadPages |
534 |
| - description: Pages of data read from a stream slice. |
535 | 536 | StreamReadSlices:
|
536 | 537 | properties:
|
537 | 538 | pages:
|
@@ -577,7 +578,6 @@ components:
|
577 | 578 | items: {}
|
578 | 579 | type: array
|
579 | 580 | title: State
|
580 |
| - default: [] |
581 | 581 | custom_components_code:
|
582 | 582 | anyOf:
|
583 | 583 | - type: string
|
|
0 commit comments