diff --git a/openapi/swagger.json b/openapi/swagger.json index 4bf91f6..4110b18 100644 --- a/openapi/swagger.json +++ b/openapi/swagger.json @@ -1602,6 +1602,182 @@ } }, "/tables/{tableID}/rows/{rowID}": { + "get": { + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": {}, + "description": "A row object conforming to the schema of the table, where keys are the column IDs and values are the column values:\n\n```json\n{\n\t\"fullName\": \"Alex Bard\",\n\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\"totalAmount\": 34.50,\n\t\"amountPaid\": 0\n}\n```", + "example": { + "fullName": "Alex Bard", + "invoiceDate": "2024-07-29T14:04:15.561Z", + "totalAmount": 34.5, + "amountPaid": 0 + } + }, + "description": "A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```", + "example": [ + { + "fullName": "Alex Bard", + "invoiceDate": "2024-07-29T14:04:15.561Z", + "totalAmount": 34.5, + "amountPaid": 0 + }, + { + "fullName": "Alicia Hines", + "invoiceDate": "2023-06-15T10:30:00.000Z", + "totalAmount": 50.75, + "amountPaid": 20 + } + ] + } + }, + "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 + } + } + } + }, + "402": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "payment_required" + ] + }, + "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": [ + "table_not_found", + "table_not_big_table", + "row_not_found" + ] + }, + "message": { + "type": "string" + } + }, + "required": [ + "type", + "message" + ], + "additionalProperties": false + } + }, + "required": [ + "error" + ], + "additionalProperties": false + } + } + } + } + }, + "parameters": [ + { + "name": "tableID", + "in": "path", + "schema": { + "type": "string", + "description": "ID of the table, e.g., `2a1bad8b-cf7c-44437-b8c1-e3782df6`", + "example": "2a1bad8b-cf7c-44437-b8c1-e3782df6" + }, + "required": true + }, + { + "name": "rowID", + "in": "path", + "schema": { + "type": "string", + "description": "ID of the row, e.g., `zcJWnyI8Tbam21V34K8MNA`", + "example": "zcJWnyI8Tbam21V34K8MNA" + }, + "required": true + } + ], + "description": "Gets a single row from a Big Table by row ID" + }, "patch": { "responses": { "200": {