Endpoint coverage

[philkra]

Authentication

• GET /user/keys
• POST /user/keys/{key_name}
• DELETE /user/keys/{key_name}

Branch

type BranchClient interface {
  List(ctx context.Context, dbName string) (*xatagenworkspace.ListBranchesResponse, error)
  GetDetails(ctx context.Context, request BranchRequest) (*xatagenworkspace.DbBranch, error)
  Create(ctx context.Context, request CreateBranchRequest) (*xatagenworkspace.CreateBranchResponse, error)
  Delete(ctx context.Context, request BranchRequest) (*xatagenworkspace.DeleteBranchResponse, error)
}

• GET /dbs/{db_name}
• GET /db/{db_branch_name}
• PUT /db/{db_branch_name}
• DELETE /db/{db_branch_name}
• GET /db/{db_branch_name}/metadata
• PUT /db/{db_branch_name}/metadata
• GET /db/{db_branch_name}/stats
• GET /dbs/{db_name}/gitBranches
• POST /dbs/{db_name}/gitBranches
• DELETE /dbs/{db_name}/gitBranches
• GET /dbs/{db_name}/resolveBranch

Databases

type DatabasesClient interface {
  Create(ctx context.Context, request CreateDatabaseRequest) (*xatagencore.CreateDatabaseResponse, error)
  Delete(ctx context.Context, request DeleteDatabaseRequest) (*xatagencore.DeleteDatabaseResponse, error)
  GetRegions(ctx context.Context) (*xatagencore.ListRegionsResponse, error)
  GetRegionsWithWorkspaceID(ctx context.Context, workspaceID string) (*xatagencore.ListRegionsResponse, error)
  List(ctx context.Context) (*xatagencore.ListDatabasesResponse, error)
  ListWithWorkspaceID(ctx context.Context, workspaceID string) (*xatagencore.ListDatabasesResponse, error)
  Rename(ctx context.Context, request RenameDatabaseRequest) (*xatagencore.DatabaseMetadata, error)
}

• GET /workspaces/{workspace_id}/dbs
• GET /workspaces/{workspace_id}/dbs/{db_name}
• PUT /workspaces/{workspace_id}/dbs/{db_name}
• DELETE /workspaces/{workspace_id}/dbs/{db_name}
• PATCH /workspaces/{workspace_id}/dbs/{db_name}
• POST /workspaces/{workspace_id}/dbs/{db_name}/rename
• GET /workspaces/{workspace_id}/regions

Files

type FilesClient interface {
  GetItem(ctx context.Context, request GetFileItemRequest) (*xatagenworkspace.GetFileResponse, error)
  PutItem(ctx context.Context, request PutFileItemRequest) (*xatagenworkspace.FileResponse, error)
  DeleteItem(ctx context.Context, request DeleteFileItemRequest) (*xatagenworkspace.FileResponse, error)
  Get(ctx context.Context, request GetFileRequest) (*xatagenworkspace.GetFileResponse, error)
  Put(ctx context.Context, request PutFileRequest) (*xatagenworkspace.FileResponse, error)
  Delete(ctx context.Context, request DeleteFileRequest) (*xatagenworkspace.FileResponse, error)
}

• GET /db/{db_branch_name}/tables/{table_name}/data/{record_id}/column/{column_name}/file/{file_id}
• PUT /db/{db_branch_name}/tables/{table_name}/data/{record_id}/column/{column_name}/file/{file_id}
• DELETE /db/{db_branch_name}/tables/{table_name}/data/{record_id}/column/{column_name}/file/{file_id}
• GET /db/{db_branch_name}/tables/{table_name}/data/{record_id}/column/{column_name}/file
• PUT /db/{db_branch_name}/tables/{table_name}/data/{record_id}/column/{column_name}/file
• DELETE /db/{db_branch_name}/tables/{table_name}/data/{record_id}/column/{column_name}/file

Invites

• POST /workspaces/{workspace_id}/invites
• DELETE /workspaces/{workspace_id}/invites/{invite_id}
• PATCH /workspaces/{workspace_id}/invites/{invite_id}
• POST /workspaces/{workspace_id}/invites/{invite_key}/accept
• POST /workspaces/{workspace_id}/invites/{invite_id}/resend

Migrations

• GET /db/{db_branch_name}/migrations
• POST /db/{db_branch_name}/migrations/plan
• POST /db/{db_branch_name}/migrations/execute
• POST /db/{db_branch_name}/schema/history
• POST /db/{db_branch_name}/schema/compare
• POST /db/{db_branch_name}/schema/compare/{branch_name}
• POST /db/{db_branch_name}/schema/update
• POST /db/{db_branch_name}/schema/preview
• POST /db/{db_branch_name}/schema/apply
• POST /db/{db_branch_name}/schema/push

OAuth

• GET /user/oauth/clients
• DELETE /user/oauth/clients/{client_id}
• GET /user/oauth/tokens
• DELETE /user/oauth/tokens/{token}
• PATCH /user/oauth/tokens/{token}

Records

type RecordsClient interface {
  Transaction(ctx context.Context, request TransactionRequest) (*xatagenworkspace.TransactionSuccess, error)
  Insert(ctx context.Context, request InsertRecordRequest) (*Record, error)
  BulkInsert(ctx context.Context, request BulkInsertRecordRequest) ([]*Record, error)
  Update(ctx context.Context, request UpdateRecordRequest) (*Record, error)
  Upsert(ctx context.Context, request UpsertRecordRequest) (*Record, error)
  InsertWithID(ctx context.Context, request InsertRecordWithIDRequest) (*Record, error)
  Get(ctx context.Context, request GetRecordRequest) (*Record, error)
  Delete(ctx context.Context, request DeleteRecordRequest) error
}

• POST /db/{db_branch_name}/transaction
• POST /db/{db_branch_name}/tables/{table_name}/data
• GET /db/{db_branch_name}/tables/{table_name}/data/{record_id}
• PUT /db/{db_branch_name}/tables/{table_name}/data/{record_id}
• POST /db/{db_branch_name}/tables/{table_name}/data/{record_id}
• DELETE /db/{db_branch_name}/tables/{table_name}/data/{record_id}
• PATCH /db/{db_branch_name}/tables/{table_name}/data/{record_id}
• POST /db/{db_branch_name}/tables/{table_name}/bulk

Search And Filter

type SearchAndFilterClient interface {
  Query(ctx context.Context, request QueryTableRequest) (*xatagenworkspace.QueryTableResponse, error)
  SearchBranch(ctx context.Context, request SearchBranchRequest) (*xatagenworkspace.SearchBranchResponse, error)
  SearchTable(ctx context.Context, request SearchTableRequest) (*xatagenworkspace.SearchTableResponse, error)
  VectorSearch(ctx context.Context, request VectorSearchTableRequest) (*xatagenworkspace.VectorSearchTableResponse, error)
  Ask(ctx context.Context, request AskTableRequest) (*xatagenworkspace.AskTableResponse, error)
  AskFollowUp(ctx context.Context, request AskFollowUpRequest) (*xatagenworkspace.AskTableSessionResponse, error)
  Summarize(ctx context.Context, request SummarizeTableRequest) (*xatagenworkspace.SummarizeTableResponse, error)
  Aggregate(ctx context.Context, request AggregateTableRequest) (*xatagenworkspace.AggregateTableResponse, error)
}

• POST /db/{db_branch_name}/tables/{table_name}/query
• POST /db/{db_branch_name}/search
• POST /db/{db_branch_name}/tables/{table_name}/search
• POST /db/{db_branch_name}/tables/{table_name}/vectorSearch
• POST /db/{db_branch_name}/tables/{table_name}/ask
• POST /db/{db_branch_name}/tables/{table_name}/ask/{session_id}
• POST /db/{db_branch_name}/tables/{table_name}/summarize
• POST /db/{db_branch_name}/tables/{table_name}/aggregate

SQL

• POST /db/{db_branch_name}/sql

Table

type TableClient interface {
  Create(ctx context.Context, request TableRequest) (*xatagenworkspace.CreateTableResponse, error)
  Delete(ctx context.Context, request TableRequest) (*xatagenworkspace.DeleteTableResponse, error)
  AddColumn(ctx context.Context, request AddColumnRequest) (*xatagenworkspace.AddTableColumnResponse, error)
  DeleteColumn(ctx context.Context, request DeleteColumnRequest) (*xatagenworkspace.DeleteColumnResponse, error)
  GetSchema(ctx context.Context, request TableRequest) (*xatagenworkspace.GetTableSchemaResponse, error)
  GetColumns(ctx context.Context, request TableRequest) (*xatagenworkspace.GetTableColumnsResponse, error)
}

• PUT /db/{db_branch_name}/tables/{table_name}
• DELETE /db/{db_branch_name}/tables/{table_name}
• PATCH /db/{db_branch_name}/tables/{table_name}
• GET /db/{db_branch_name}/tables/{table_name}/schema
• PUT /db/{db_branch_name}/tables/{table_name}/schema
• GET /db/{db_branch_name}/tables/{table_name}/columns
• POST /db/{db_branch_name}/tables/{table_name}/columns
• GET /db/{db_branch_name}/tables/{table_name}/columns/{column_name}
• DELETE /db/{db_branch_name}/tables/{table_name}/columns/{column_name}
• PATCH /db/{db_branch_name}/tables/{table_name}/columns/{column_name}

User

type UsersClient interface {
  Get(ctx context.Context) (*xatagencore.UserWithId, error)
}

• GET /user
• PUT /user
• DELETE /user

Workspaces

type WorkspacesClient interface {
  List(ctx context.Context) (*xatagencore.GetWorkspacesListResponse, error)
  Create(ctx context.Context, request *WorkspaceMeta) (*xatagencore.Workspace, error)
  Delete(ctx context.Context, workspaceID string) error
  Get(ctx context.Context) (*xatagencore.Workspace, error)
  GetWithWorkspaceID(ctx context.Context, workspaceID string) (*xatagencore.Workspace, error)
  Update(ctx context.Context, request UpdateWorkspaceRequest) (*xatagencore.Workspace, error)
}

• GET /workspaces
• POST /workspaces
• GET /workspaces/{workspace_id}
• PUT /workspaces/{workspace_id}
• DELETE /workspaces/{workspace_id}
• GET /workspaces/{workspace_id}/members
• PUT /workspaces/{workspace_id}/members/{user_id}
• DELETE /workspaces/{workspace_id}/members/{user_id}