From 9bf24548745e30b9942af44fcffdd2297f33b5b4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 18 Sep 2025 13:32:51 +0000 Subject: [PATCH 1/5] Update from https://github.com/glideapps/glide/commit/e59e6b036929d31bb0398d94f79df01f5a02829f --- openapi/swagger.json | 240 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 240 insertions(+) diff --git a/openapi/swagger.json b/openapi/swagger.json index a40ae33..64ec5a8 100644 --- a/openapi/swagger.json +++ b/openapi/swagger.json @@ -183,6 +183,41 @@ } } }, + "202": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "tableID": { + "type": "string", + "description": "ID of the table, e.g., `2a1bad8b-cf7c-44437-b8c1-e3782df6`", + "example": "2a1bad8b-cf7c-44437-b8c1-e3782df6" + }, + "jobID": { + "type": "string", + "description": "The ID of the job handling the table creation" + } + }, + "required": [ + "tableID", + "jobID" + ], + "additionalProperties": false + } + }, + "required": [ + "data" + ], + "additionalProperties": false + } + } + } + }, "400": { "description": "", "content": { @@ -290,6 +325,18 @@ } }, "parameters": [ + { + "name": "x-glide-asynchronous", + "in": "header", + "schema": { + "type": "string", + "enum": [ + "true", + "false" + ] + }, + "required": false + }, { "name": "name", "in": "query", @@ -725,6 +772,18 @@ } }, "parameters": [ + { + "name": "x-glide-asynchronous", + "in": "header", + "schema": { + "type": "string", + "enum": [ + "true", + "false" + ] + }, + "required": false + }, { "name": "appsToLink", "in": "query", @@ -759,6 +818,11 @@ "schema": { "type": "object", "properties": { + "displayName": { + "type": "string", + "description": "Name of the table, e.g., `Invoices`", + "example": "Invoices" + }, "fromUrl": { "type": "string", "format": "uri", @@ -838,6 +902,34 @@ } } }, + "202": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "workflowID": { + "type": "string" + } + }, + "required": [ + "workflowID" + ], + "additionalProperties": false + } + }, + "required": [ + "data" + ], + "additionalProperties": false + } + } + } + }, "400": { "description": "", "content": { @@ -1016,6 +1108,18 @@ } }, "parameters": [ + { + "name": "x-glide-asynchronous", + "in": "header", + "schema": { + "type": "string", + "enum": [ + "true", + "false" + ] + }, + "required": false + }, { "name": "if-match", "in": "header", @@ -2398,6 +2502,142 @@ "description": "Deletes a row from a Big Table" } }, + "/jobs/{jobID}": { + "get": { + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "running", + "completed", + "failed" + ], + "description": "The current status of the job" + }, + "result": { + "description": "The result of the job, if it is completed" + }, + "error": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message describing the error" + } + }, + "required": [ + "message" + ], + "additionalProperties": false, + "description": "The error information, if the job failed" + } + }, + "required": [ + "status" + ], + "additionalProperties": false + } + }, + "required": [ + "data" + ], + "additionalProperties": false + } + } + } + }, + "400": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "required": [ + "type", + "message" + ], + "additionalProperties": false + } + }, + "required": [ + "error" + ], + "additionalProperties": false + } + } + } + }, + "404": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "job_not_found" + ] + }, + "message": { + "type": "string" + } + }, + "required": [ + "type", + "message" + ], + "additionalProperties": false + } + }, + "required": [ + "error" + ], + "additionalProperties": false + } + } + } + } + }, + "parameters": [ + { + "name": "jobID", + "in": "path", + "schema": { + "type": "string", + "description": "The ID of the job to check" + }, + "required": true + } + ], + "description": "Check whether a job is finished, and get its result" + } + }, "/stashes/{stashID}/{serial}": { "put": { "responses": { From f084c0d0d17ab98cf737b3cf91a1723a2e25e034 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 19 Sep 2025 18:32:19 +0000 Subject: [PATCH 2/5] Update from https://github.com/glideapps/glide/commit/43397403c95a625616957b3afac84525df328741 --- openapi/swagger.json | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/openapi/swagger.json b/openapi/swagger.json index 64ec5a8..45fc493 100644 --- a/openapi/swagger.json +++ b/openapi/swagger.json @@ -333,7 +333,8 @@ "enum": [ "true", "false" - ] + ], + "description": "Allow asynchronous processing, which will return a job ID." }, "required": false }, @@ -780,7 +781,8 @@ "enum": [ "true", "false" - ] + ], + "description": "Allow asynchronous processing, which will return a job ID." }, "required": false }, @@ -1116,7 +1118,8 @@ "enum": [ "true", "false" - ] + ], + "description": "Allow asynchronous processing, which will return a job ID." }, "required": false }, From e23f2fadf59e34811e7f464bce0a35e86b2dd289 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 22 Sep 2025 17:42:56 +0000 Subject: [PATCH 3/5] Update from https://github.com/glideapps/glide/commit/494fc16aea3b522337559c8519cca7f353064f25 --- openapi/swagger.json | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/openapi/swagger.json b/openapi/swagger.json index 45fc493..64ec5a8 100644 --- a/openapi/swagger.json +++ b/openapi/swagger.json @@ -333,8 +333,7 @@ "enum": [ "true", "false" - ], - "description": "Allow asynchronous processing, which will return a job ID." + ] }, "required": false }, @@ -781,8 +780,7 @@ "enum": [ "true", "false" - ], - "description": "Allow asynchronous processing, which will return a job ID." + ] }, "required": false }, @@ -1118,8 +1116,7 @@ "enum": [ "true", "false" - ], - "description": "Allow asynchronous processing, which will return a job ID." + ] }, "required": false }, From 0a976c5b5cfe9a5f675fa564edabc51b919ff6c5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 22 Sep 2025 17:48:36 +0000 Subject: [PATCH 4/5] Update from https://github.com/glideapps/glide/commit/395bd43c00c0c6819ec6f4a7688e8da639488215 --- openapi/swagger.json | 33 ++++++++++++--------------------- 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/openapi/swagger.json b/openapi/swagger.json index 64ec5a8..9ec862b 100644 --- a/openapi/swagger.json +++ b/openapi/swagger.json @@ -200,7 +200,7 @@ }, "jobID": { "type": "string", - "description": "The ID of the job handling the table creation" + "description": "The ID of the asynchronous job" } }, "required": [ @@ -333,7 +333,8 @@ "enum": [ "true", "false" - ] + ], + "description": "Allow asynchronous processing, which will return a job ID. Note that this does not force asynchronouys processing. The caller must handle both synchronous and asynchronous responses." }, "required": false }, @@ -772,18 +773,6 @@ } }, "parameters": [ - { - "name": "x-glide-asynchronous", - "in": "header", - "schema": { - "type": "string", - "enum": [ - "true", - "false" - ] - }, - "required": false - }, { "name": "appsToLink", "in": "query", @@ -912,12 +901,13 @@ "data": { "type": "object", "properties": { - "workflowID": { - "type": "string" + "jobID": { + "type": "string", + "description": "The ID of the asynchronous job" } }, "required": [ - "workflowID" + "jobID" ], "additionalProperties": false } @@ -1116,7 +1106,8 @@ "enum": [ "true", "false" - ] + ], + "description": "Allow asynchronous processing, which will return a job ID. Note that this does not force asynchronouys processing. The caller must handle both synchronous and asynchronous responses." }, "required": false }, @@ -2519,13 +2510,13 @@ "type": "string", "enum": [ "running", - "completed", + "succeeded", "failed" ], "description": "The current status of the job" }, "result": { - "description": "The result of the job, if it is completed" + "description": "The result of the job, if it `succeeded`" }, "error": { "type": "object", @@ -2539,7 +2530,7 @@ "message" ], "additionalProperties": false, - "description": "The error information, if the job failed" + "description": "The error information, if the job `failed`" } }, "required": [ From 04cf47482b2acb18f726d53acba7e98ecb483bb6 Mon Sep 17 00:00:00 2001 From: Mark Probst Date: Tue, 23 Sep 2025 07:41:14 -0400 Subject: [PATCH 5/5] Add page for job status --- api-reference/v2/jobs/get-job.mdx | 6 ++ mint.json | 151 +++++++++++++++--------------- 2 files changed, 81 insertions(+), 76 deletions(-) create mode 100644 api-reference/v2/jobs/get-job.mdx diff --git a/api-reference/v2/jobs/get-job.mdx b/api-reference/v2/jobs/get-job.mdx new file mode 100644 index 0000000..dcd81f4 --- /dev/null +++ b/api-reference/v2/jobs/get-job.mdx @@ -0,0 +1,6 @@ +--- +title: Get Job Status +openapi: get /jobs/{jobID} +--- + +Returns the status of an asynchronous job. diff --git a/mint.json b/mint.json index a514052..e72b9f1 100644 --- a/mint.json +++ b/mint.json @@ -1,81 +1,80 @@ { - "openapi": "/openapi/swagger.json", - "name": "Glide API Docs", - "favicon": "/logo/favicon.svg", - "colors": { - "primary": "#18BED4", - "light": "#B7B2F0", - "dark": "#18BED4", - "anchors": { - "from": "#D7E779", - "to": "#07C983" - } - }, - "topbarLinks": [ - { - "name": "Glide User Docs", - "url": "https://www.glideapps.com/docs" - } - ], - "topbarCtaButton": { - "name": "Open Glide", - "url": "https://go.glideapps.com" - }, - "navigation": [ - { - "group": "General", - "pages": [ - "api-reference/v2/general/introduction", - "api-reference/v2/general/authentication", - "api-reference/v2/general/errors", - "api-reference/v2/general/limits" - ] - }, - { - "group": "Tables", - "pages": [ - "api-reference/v2/tables/versioning", - "api-reference/v2/tables/get-tables", - "api-reference/v2/tables/get-table-rows", - "api-reference/v2/tables/get-table-row", - "api-reference/v2/tables/head-table-rows", - "api-reference/v2/tables/post-tables", - "api-reference/v2/tables/post-table-rows", - "api-reference/v2/tables/put-tables", - "api-reference/v2/tables/patch-table-row", - "api-reference/v2/tables/delete-table-row" - ] + "openapi": "/openapi/swagger.json", + "name": "Glide API Docs", + "favicon": "/logo/favicon.svg", + "colors": { + "primary": "#18BED4", + "light": "#B7B2F0", + "dark": "#18BED4", + "anchors": { + "from": "#D7E779", + "to": "#07C983" + } }, - { - "group": "Stashing", - "pages": [ - "api-reference/v2/stashing/introduction", - "api-reference/v2/stashing/put-stashes-serial", - "api-reference/v2/stashing/delete-stash" - ] + "topbarLinks": [ + { + "name": "Glide User Docs", + "url": "https://www.glideapps.com/docs" + } + ], + "topbarCtaButton": { + "name": "Open Glide", + "url": "https://go.glideapps.com" }, - { - "group": "Tutorials", - "pages": [ - "api-reference/v2/tutorials/bulk-import" - ] + "navigation": [ + { + "group": "General", + "pages": [ + "api-reference/v2/general/introduction", + "api-reference/v2/general/authentication", + "api-reference/v2/general/errors", + "api-reference/v2/general/limits" + ] + }, + { + "group": "Tables", + "pages": [ + "api-reference/v2/tables/versioning", + "api-reference/v2/tables/get-tables", + "api-reference/v2/tables/get-table-rows", + "api-reference/v2/tables/get-table-row", + "api-reference/v2/tables/head-table-rows", + "api-reference/v2/tables/post-tables", + "api-reference/v2/tables/post-table-rows", + "api-reference/v2/tables/put-tables", + "api-reference/v2/tables/patch-table-row", + "api-reference/v2/tables/delete-table-row" + ] + }, + { + "group": "Stashing", + "pages": [ + "api-reference/v2/stashing/introduction", + "api-reference/v2/stashing/put-stashes-serial", + "api-reference/v2/stashing/delete-stash" + ] + }, + { + "group": "Jobs", + "pages": ["api-reference/v2/jobs/get-job"] + }, + { + "group": "Tutorials", + "pages": ["api-reference/v2/tutorials/bulk-import"] + }, + { + "group": "Resources", + "pages": ["api-reference/v2/resources/postman", "api-reference/v2/resources/changelog"] + } + ], + "footerSocials": { + "youtube": "https://www.youtube.com/glideapps", + "x": "https://x.com/glideapps", + "github": "https://github.com/glideapps", + "linkedin": "https://www.linkedin.com/company/glideapps/" }, - { - "group": "Resources", - "pages": [ - "api-reference/v2/resources/postman", - "api-reference/v2/resources/changelog" - ] + "feedback": { + "thumbsRating": true, + "raiseIssue": true } - ], - "footerSocials": { - "youtube": "https://www.youtube.com/glideapps", - "x": "https://x.com/glideapps", - "github": "https://github.com/glideapps", - "linkedin": "https://www.linkedin.com/company/glideapps/" - }, - "feedback": { - "thumbsRating": true, - "raiseIssue": true - } -} \ No newline at end of file +}