diff --git a/CHANGELOG.md b/CHANGELOG.md index 579567c4..07228bc3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Upgraded to use OpenAPI Specification 3.1. +## 0.16.0 2024-10-28 + +### Changed + +- `BulkUpload` is now `BulkUploadTask`. +- `GET /bulkUpload` and `POST /bulkUpload` are now `GET /tasks/bulkUpload` and `POST /tasks/bulkUpload`. + Future jobs for the graphile-worker will be routed under `tasks` as well. + + ## 0.15.1 2024-10-28 ### Fixed diff --git a/src/openapi.json b/src/openapi.json index 250dabf3..4aeb5690 100644 --- a/src/openapi.json +++ b/src/openapi.json @@ -108,7 +108,7 @@ } }, "schemas": { - "BulkUpload": { + "BulkUploadTask": { "type": "object", "properties": { "id": { @@ -174,7 +174,7 @@ "createdAt" ] }, - "BulkUploadBundle": { + "BulkUploadTaskBundle": { "allOf": [ { "$ref": "#/components/schemas/Bundle" @@ -185,7 +185,7 @@ "entries": { "type": "array", "items": { - "$ref": "#/components/schemas/BulkUpload" + "$ref": "#/components/schemas/BulkUploadTask" } } }, @@ -1124,11 +1124,11 @@ } } }, - "/bulkUploads": { + "/tasks/bulkUploads": { "get": { - "operationId": "getBulkUploads", - "summary": "Gets a list of bulk uploads.", - "tags": ["Bulk Uploads"], + "operationId": "getBulkUploadTasks", + "summary": "Gets a list of bulk upload tasks.", + "tags": ["Tasks","Bulk Uploads"], "security": [ { "auth": [] @@ -1145,7 +1145,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BulkUploadBundle" + "$ref": "#/components/schemas/BulkUploadTaskBundle" } } } @@ -1163,8 +1163,8 @@ } }, "post": { - "operationId": "addBulkUpload", - "summary": "Registers a bulk upload. This lets PDC ingest data previously uploaded via a POST to the /presignedPostRequests endpoint.", + "operationId": "addBulkUploadTask", + "summary": "Registers a bulk upload task. This lets PDC ingest data previously uploaded via a POST to the /presignedPostRequests endpoint.", "tags": ["Bulk Uploads"], "security": [ { @@ -1176,7 +1176,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BulkUpload" + "$ref": "#/components/schemas/BulkUploadTask" } } } @@ -1187,7 +1187,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BulkUpload" + "$ref": "#/components/schemas/BulkUploadTask" } } } @@ -1435,7 +1435,7 @@ }, "responses": { "201": { - "description": "The presigned post request. Use the contents of this JSON to POST form data to S3. After posting data to S3, use the /bulkUploads endpoint to let PDC ingest the data.", + "description": "The presigned post request. Use the contents of this JSON to POST form data to S3. After posting data to S3, use the /bulkUploadTasks endpoint to let PDC ingest the data.", "content": { "application/json": { "schema": {