cube-js/cube

Format does not return on the REST API when querying a view

Open

#7,444 opened on Nov 21, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (19,563 stars) (1,965 forks)batch import
data modeling:viewshelp wanted

Description

Describe the bug If you add the format field to a metric on a cube and then include that metric in a view, the format field is not returned in the API /meta or /query response for the view. Format is included in for the metric on the cube - just not the view.

To Reproduce Steps to reproduce the behaviour:

  1. Create a cube with one or more metrics
  2. Add format: currency or format: percent to the metrics
  3. Create a view that includes the metrics in 1)
  4. Make a request to the /meta or /query endpoints on the REST API.
  5. You will see the format field is returned for the cube but not the view.

Expected behaviour I would expect the format field to be included in the annotations object of the /query response if I query the view. Otherwise, it is not possible to apply the format on the client.

Additional context Both description and meta fields are carried through to the view response from the underlying cube.

Contributor guide

Tech stack
rustrest api
Domain
api
Issue type
bug
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-3 hours
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
Basic understanding of Cube.jsREST API concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the view endpoint handler in the Cube backend (likely Rust code). Investigate how format field is propagated from cube metrics to view annotations. Ensure that format is included in the /meta and /query responses for views, similar to description and meta fields. Look for any transformation that might drop the format attribute.