cube-js/cube

Meta API (`/meta`): Add the `sql_table` field to the response

Open

#8,711 opened on Sep 16, 2024

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Rust (1,965 forks)batch import
api:resthelp wanted

Repository metrics

Stars
 (19,563 stars)
PR merge metrics
 (Avg merge 4d 17h) (136 merged PRs in 30d)

Description

The /v1/meta API endpoint does not include the sql_table field. Even with the ?extended query param the sql_table field does not exist, even though sql does. It would also be great to have this included unless there is a good reason not to.

I believe it's the following function that needs to be adapted along with the unit tests: https://github.com/cube-js/cube/blob/e8d81f2e04ce61215b1185d9adc4320233bc34da/packages/cubejs-api-gateway/src/helpers/transformMetaExtended.ts#L37

I'm happy to open a pull request for the same!

Contributor guide

Research direction
The issue is to add the `sql table` field to the `/v1/meta` API response. The specific file to modify is `packages/cubejs api gateway/src/helpers/transformMetaExtended.ts`, specifically the function around line 37. You will need to add the field and update the corresponding unit tests. No pull request is currently linked, so this issue is available for a first time contributor.
Tech stack
typescriptnodejsrest api
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptREST API experienceUnit testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90