PgBeam
Get Started
PgBeam Docs

Delete a schema annotation

DELETE
/v1/projects/{project_id}/schema-annotations

Removes a single annotation identified by its natural key. Omit column_name to delete a table-level annotation, and omit schema_name to match the unqualified form.

Authorization

AuthorizationBearer <token>

JWT issued by Better Auth. Verified via JWKS.

In: header

Path Parameters

project_id*string

Unique project identifier (prefixed, e.g. prj_xxx).

Match^[a-zA-Z0-9_.-]+$

Query Parameters

table_name*string

Relation (table or view) the annotation describes.

Length1 <= length <= 255
schema_name?string

Optional schema. Omit to match the unqualified form.

Lengthlength <= 255
column_name?string

Optional column. Omit to delete a table-level annotation.

Lengthlength <= 255

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/projects/string/schema-annotations?table_name=string"
Empty
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}