gristlabs/grist-core

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

Open

#732 geöffnet am 8. Nov. 2023

Auf GitHub ansehen
 (4 Kommentare) (1 Reaktion) (0 zugewiesene Personen)TypeScript (3.613 Stars) (168 Forks)batch import
enhancementgood first issue

Beschreibung

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

Tech Stack
typescript
Domain
backendapi
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Understanding of Grist's APIFamiliarity with formula systemTypeScript proficiency
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45
Research-Richtung
Examine the existing API endpoints in Grist's source code, likely in the 'api' directory. Investigate the formula evaluation logic to understand how references and formulas are computed. Consider how to extend the current SQL API or create a new endpoint to accept formulas and return computed columns alongside row data.