From 769d5a0f89b2700612c0320c59e6b0e67b091002 Mon Sep 17 00:00:00 2001 From: rintcius Date: Tue, 22 Sep 2026 15:52:14 +0200 Subject: [PATCH 1/2] document per-dataset debug options for loads --- reference/public-http-api.yaml | 129 +++++++++++++++++++++++++++++++-- 1 file changed, 123 insertions(+), 6 deletions(-) diff --git a/reference/public-http-api.yaml b/reference/public-http-api.yaml index 0b42396..a5ea96a 100644 --- a/reference/public-http-api.yaml +++ b/reference/public-http-api.yaml @@ -824,6 +824,49 @@ paths: action: add datasetIds: - string + '/pipelines/{pipeline-id}/datasets/{dataset-id}': + parameters: + - schema: + type: string + name: pipeline-id + in: path + required: true + - schema: + type: string + name: dataset-id + in: path + required: true + post: + summary: Add a dataset to the provided pipeline + operationId: post-pipelines-pipeline-id-datasets-dataset-id + responses: + '204': + description: No Content + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/error-message' + '401': + description: Unauthorized + '404': + description: Pipeline or dataset not found. + '422': + description: Semantic error. + content: + application/json: + schema: + $ref: '#/components/schemas/error-message' + description: >- + Add one dataset to the pipeline and start its initial load. Omit the body to use the + default initial-load parameters with debug disabled. + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/initial-load-params' '/pipelines/{pipeline-id}/details': parameters: - schema: @@ -948,10 +991,20 @@ paths: responses: '202': description: Accepted - there are in-band datasets and a load has been scheduled to start + content: + application/json: + schema: + type: string + minLength: 1 + description: Pipeline load ID '204': description: No Content - there are no in-band datasets '400': - description: Bad Request - there are no datasets in pipeline + description: Bad Request - the body is invalid or there are no datasets in the pipeline + content: + text/plain: + schema: + type: string '401': description: Unauthorized '402': @@ -978,6 +1031,16 @@ paths: - error '404': description: Pipeline not found. + content: + text/plain: + schema: + type: string + '500': + description: The load request failed, including when another load is already in progress. + content: + text/plain: + schema: + type: string '502': description: Problematic Request to External Server content: @@ -986,14 +1049,15 @@ paths: $ref: '#/components/schemas/error-message' description: Start a load for this pipeline. requestBody: + required: false content: application/json: schema: - type: object - properties: - returnUrl: - type: string - description: '' + $ref: '#/components/schemas/pipeline-load-request' + description: >- + Omit the body, omit `datasets`, or send an empty object to start a full load with + debug disabled. A non-empty `datasets` array starts a partial load. An empty array, + malformed entry, or repeated dataset ID is rejected with a 400 response. '/pipelines/{pipeline-id}/rename': parameters: - schema: @@ -2704,6 +2768,10 @@ components: properties: initialWrite: type: boolean + debug: + type: boolean + default: false + description: Enable immediate reader logging for this dataset's initial load. readRequired: type: boolean default: false @@ -2716,6 +2784,34 @@ components: $ref: '#/components/schemas/initial-load-params-message-limit' required: - initialWrite + pipeline-load-request: + title: pipeline-load-request + type: object + additionalProperties: false + properties: + datasets: + type: array + minItems: 1 + uniqueItems: true + description: >- + Datasets to include in a partial standard load. Dataset IDs must be unique. + Unknown IDs are ignored; if none belong to the pipeline, the request fails. + items: + $ref: '#/components/schemas/pipeline-load-dataset-options' + pipeline-load-dataset-options: + title: pipeline-load-dataset-options + type: object + additionalProperties: false + properties: + id: + type: string + minLength: 1 + debug: + type: boolean + default: false + description: Enable immediate reader logging for this dataset's load. + required: + - id initial-load-params-message-limit: title: initial-load-params-message-limit type: object @@ -2906,6 +3002,27 @@ components: minLength: 1 loadParameters: $ref: '#/components/schemas/initial-load-params' + datasetOverrides: + type: object + description: Initial-load parameter overrides keyed by dataset ID. + additionalProperties: + $ref: '#/components/schemas/optional-initial-load-params' + optional-initial-load-params: + title: optional-initial-load-params + type: object + properties: + initialWrite: + type: boolean + debug: + type: boolean + readRequired: + type: boolean + reusePreviousSchema: + type: boolean + reusePreviousPrimaryKey: + $ref: '#/components/schemas/reuse-previous-primary-key' + sampleParameters: + $ref: '#/components/schemas/initial-load-params-message-limit' error-message: title: error-message type: object From 436f28f92dbe5862985dad99c336367d6aca9d02 Mon Sep 17 00:00:00 2001 From: rintcius Date: Tue, 22 Sep 2026 15:59:19 +0200 Subject: [PATCH 2/2] remove single-dataset add endpoint from spec --- reference/public-http-api.yaml | 43 ---------------------------------- 1 file changed, 43 deletions(-) diff --git a/reference/public-http-api.yaml b/reference/public-http-api.yaml index a5ea96a..5085cc6 100644 --- a/reference/public-http-api.yaml +++ b/reference/public-http-api.yaml @@ -824,49 +824,6 @@ paths: action: add datasetIds: - string - '/pipelines/{pipeline-id}/datasets/{dataset-id}': - parameters: - - schema: - type: string - name: pipeline-id - in: path - required: true - - schema: - type: string - name: dataset-id - in: path - required: true - post: - summary: Add a dataset to the provided pipeline - operationId: post-pipelines-pipeline-id-datasets-dataset-id - responses: - '204': - description: No Content - '400': - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/error-message' - '401': - description: Unauthorized - '404': - description: Pipeline or dataset not found. - '422': - description: Semantic error. - content: - application/json: - schema: - $ref: '#/components/schemas/error-message' - description: >- - Add one dataset to the pipeline and start its initial load. Omit the body to use the - default initial-load parameters with debug disabled. - requestBody: - required: false - content: - application/json: - schema: - $ref: '#/components/schemas/initial-load-params' '/pipelines/{pipeline-id}/details': parameters: - schema: