gristlabs/grist-core

[Enhancement] Add API call to evaluate formula(s?) in the context of rows

Open

#732 opened on Nov 8, 2023

View on GitHub
 (4 comments) (1 reaction) (0 assignees)TypeScript (168 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (3,613 stars)
PR merge metrics
 (Avg merge 11d 9h) (47 merged PRs in 30d)

Description

Within formulas in rows, I can follow references like $Person.Full_Name, if $Person refers to a reference column. Trying to do the same from within an API client is kind of cumbersome, even with the recently-added SQL API support (thanks btw!). It would be nice if I could just supply a few formulas when requesting records from a table, and the values of the formulas get computed and added as additional columns in the response.

Contributor guide

Research direction
Study existing API endpoints in the codebase (e.g., /api/docs/) to understand how to add a new endpoint. Then implement formula evaluation using the existing formula engine.
Tech stack
typescript
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptREST API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60