|
896 | 896 | } |
897 | 897 | }, |
898 | 898 | "/tables/{tableID}/rows": { |
| 899 | + "get": { |
| 900 | + "responses": { |
| 901 | + "200": { |
| 902 | + "description": "", |
| 903 | + "content": { |
| 904 | + "application/json": { |
| 905 | + "schema": { |
| 906 | + "type": "object", |
| 907 | + "properties": { |
| 908 | + "data": { |
| 909 | + "type": "array", |
| 910 | + "items": { |
| 911 | + "type": "object", |
| 912 | + "additionalProperties": {}, |
| 913 | + "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```", |
| 914 | + "example": { |
| 915 | + "fullName": "Alex Bard", |
| 916 | + "invoiceDate": "2024-07-29T14:04:15.561Z", |
| 917 | + "totalAmount": 34.5, |
| 918 | + "amountPaid": 0 |
| 919 | + } |
| 920 | + }, |
| 921 | + "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```", |
| 922 | + "example": [ |
| 923 | + { |
| 924 | + "fullName": "Alex Bard", |
| 925 | + "invoiceDate": "2024-07-29T14:04:15.561Z", |
| 926 | + "totalAmount": 34.5, |
| 927 | + "amountPaid": 0 |
| 928 | + }, |
| 929 | + { |
| 930 | + "fullName": "Alicia Hines", |
| 931 | + "invoiceDate": "2023-06-15T10:30:00.000Z", |
| 932 | + "totalAmount": 50.75, |
| 933 | + "amountPaid": 20 |
| 934 | + } |
| 935 | + ] |
| 936 | + }, |
| 937 | + "continuation": { |
| 938 | + "type": "string", |
| 939 | + "description": "A continuation token for fetching the next set of rows. If this is not provided, this response contains the last set of rows." |
| 940 | + } |
| 941 | + }, |
| 942 | + "required": [ |
| 943 | + "data" |
| 944 | + ], |
| 945 | + "additionalProperties": false |
| 946 | + } |
| 947 | + } |
| 948 | + } |
| 949 | + }, |
| 950 | + "400": { |
| 951 | + "description": "", |
| 952 | + "content": { |
| 953 | + "application/json": { |
| 954 | + "schema": { |
| 955 | + "type": "object", |
| 956 | + "properties": { |
| 957 | + "error": { |
| 958 | + "type": "object", |
| 959 | + "properties": { |
| 960 | + "type": { |
| 961 | + "type": "string" |
| 962 | + }, |
| 963 | + "message": { |
| 964 | + "type": "string" |
| 965 | + } |
| 966 | + }, |
| 967 | + "required": [ |
| 968 | + "type", |
| 969 | + "message" |
| 970 | + ], |
| 971 | + "additionalProperties": false |
| 972 | + } |
| 973 | + }, |
| 974 | + "required": [ |
| 975 | + "error" |
| 976 | + ], |
| 977 | + "additionalProperties": false |
| 978 | + } |
| 979 | + } |
| 980 | + } |
| 981 | + } |
| 982 | + }, |
| 983 | + "parameters": [ |
| 984 | + { |
| 985 | + "name": "tableID", |
| 986 | + "in": "path", |
| 987 | + "schema": { |
| 988 | + "type": "string", |
| 989 | + "description": "ID of the table, e.g., `2a1bad8b-cf7c-44437-b8c1-e3782df6`", |
| 990 | + "example": "2a1bad8b-cf7c-44437-b8c1-e3782df6" |
| 991 | + }, |
| 992 | + "required": true |
| 993 | + }, |
| 994 | + { |
| 995 | + "name": "limit", |
| 996 | + "in": "query", |
| 997 | + "schema": { |
| 998 | + "type": "number", |
| 999 | + "default": 250, |
| 1000 | + "description": "Maximum number of rows to return in a single response. No more than this number of rows will be returned, however fewer rows may be returned, even if there are more rows to fetch. If there are more rows, the response will include a continuation token that can be used to fetch the next set of rows." |
| 1001 | + }, |
| 1002 | + "required": false |
| 1003 | + }, |
| 1004 | + { |
| 1005 | + "name": "continuation", |
| 1006 | + "in": "query", |
| 1007 | + "schema": { |
| 1008 | + "type": "string", |
| 1009 | + "description": "A continuation token from a previous response. If provided, the next set of rows will be returned. If not provided, the first set of rows will be returned." |
| 1010 | + }, |
| 1011 | + "required": false |
| 1012 | + } |
| 1013 | + ], |
| 1014 | + "description": "Gets rows from a Big Table" |
| 1015 | + }, |
899 | 1016 | "post": { |
900 | 1017 | "responses": { |
901 | 1018 | "201": { |
|
0 commit comments