Skip to content

Commit

Permalink
Update openapi.json and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
hminsky2002 committed Nov 7, 2024
1 parent ebf68a8 commit 472f560
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 13 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 13 additions & 13 deletions src/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
}
},
"schemas": {
"BulkUpload": {
"BulkUploadTask": {
"type": "object",
"properties": {
"id": {
Expand Down Expand Up @@ -174,7 +174,7 @@
"createdAt"
]
},
"BulkUploadBundle": {
"BulkUploadTaskBundle": {
"allOf": [
{
"$ref": "#/components/schemas/Bundle"
Expand All @@ -185,7 +185,7 @@
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkUpload"
"$ref": "#/components/schemas/BulkUploadTask"
}
}
},
Expand Down Expand Up @@ -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": []
Expand All @@ -1145,7 +1145,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUploadBundle"
"$ref": "#/components/schemas/BulkUploadTaskBundle"
}
}
}
Expand All @@ -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": [
{
Expand All @@ -1176,7 +1176,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUpload"
"$ref": "#/components/schemas/BulkUploadTask"
}
}
}
Expand All @@ -1187,7 +1187,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUpload"
"$ref": "#/components/schemas/BulkUploadTask"
}
}
}
Expand Down Expand Up @@ -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": {
Expand Down

0 comments on commit 472f560

Please sign in to comment.