47 lines
1.2 KiB
Plaintext
47 lines
1.2 KiB
Plaintext
---
|
|
title: API CRUD OPTIONS | Datasquirel docs
|
|
description: Inspect available CRUD operations for a table
|
|
page_title: OPTIONS
|
|
page_description: Retrieve metadata about the CRUD operations available for a table.
|
|
---
|
|
|
|
## Overview
|
|
|
|
The OPTIONS endpoint returns metadata about the available operations for a given table — useful for dynamically discovering what fields and actions are supported.
|
|
|
|
## REST API
|
|
|
|
```
|
|
OPTIONS /api/v1/crud/{dbName}/{tableName}
|
|
```
|
|
|
|
**Headers:**
|
|
```
|
|
Authorization: Bearer YOUR_API_KEY
|
|
```
|
|
|
|
## Response
|
|
|
|
The response includes information about the table schema and the HTTP methods supported for that table.
|
|
|
|
```json
|
|
{
|
|
"success": true,
|
|
"payload": {
|
|
"methods": ["GET", "POST", "PUT", "DELETE"],
|
|
"schema": [
|
|
{ "name": "id", "type": "int", "required": true },
|
|
{ "name": "name", "type": "varchar(255)", "required": true },
|
|
{ "name": "email", "type": "varchar(255)", "required": false }
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Related
|
|
|
|
- [GET](/docs/api-reference/crud/get) — read records
|
|
- [POST](/docs/api-reference/crud/post) — create records
|
|
- [PUT](/docs/api-reference/crud/put) — update records
|
|
- [DELETE](/docs/api-reference/crud/delete) — delete records
|