cube-js/cube

Payload and Response Improvement

Open

#1,019 opened on Aug 24, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (19,563 stars) (1,965 forks)batch import
client:corehelp wanted

Description

Problem When wanting to display the selected Filters and/or Segments instead of getting that data from orderMembers in the payload and annotations in the response extra code is needed to parse that data from the metadata and/or other JSON properties.

Solution Have the same output pattern followed for Filters and Segments to appear in orderMembers payload and annotations response

Alternatives we've considered We've solved by writing additional logic, which does also add additional requests and we're trying to lower the number of requests.

Contributor guide

Tech stack
javascripttypescriptnodejsrest api
Domain
backendapianalytics
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-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.
mostly clear
Prerequisites
Understanding of Cube.js APIFamiliarity with REST API design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review Cube.js query processing code, specifically how 'orderMembers' and 'annotations' are constructed. The goal is to ensure filters and segments are included directly in these fields rather than buried in metadata. Check existing tests and documentation for current behavior.