Skip to content

Commit

Permalink
Fix API schema description
Browse files Browse the repository at this point in the history
  • Loading branch information
msfstef committed Oct 14, 2024
1 parent 3fd74f0 commit 5e0f2ec
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions website/electric-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,17 @@ paths:
Optional list of columns to include in the rows from the `root_table`.
They should always include the primary key columns, and should be formed
as a comma separated list of column names exactly as they are on the database schema.
as a comma separated list of column names exactly as they are in the database schema.
If the identifier was defined as case sensitive and/or with special characters, then\
you must quote it in the `columns` parameter as well.
examples:
select_columns:
value: "id,title,status"
summary: Only include the id, title, and status columns'.
summary: Only include the id, title, and status columns.
select_columns_special:
value: 'id,"Status-Check"'
summary: Only include id and Status-Check columns, quoting the identifiers where necessary.
# Headers
- name: If-None-Match
in: header
Expand Down

0 comments on commit 5e0f2ec

Please sign in to comment.