cube-js/cube

Playground REST API tab should display array format for order parameter

Open

#10328 opened on Jan 22, 2026

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

Description

Description

The Playground's REST API tab displays the order parameter as an object:

"order": {
  "orders.raw_customers_last_name": "asc",
  "orders.raw_customers_first_name": "desc"
}

However, Cube's own documentation recommends the alternative order format (array) for reliable multi-column ordering:

"order": [
  ["orders.raw_customers_last_name", "asc"],
  ["orders.raw_customers_first_name", "desc"]
]

Why this matters

  1. JSON object key order is not guaranteed by RFC 7159. While modern JS engines preserve insertion order, this is implementation-dependent and can break across different languages, parsers, or environments.

  2. The REST API tab's purpose is to provide copyable examples for integrators. Showing the object format sets developers up for subtle ordering bugs when they copy it into their applications.

  3. Consistency: Issue #7217 already requests that Vue's query builder use the array format. The Playground's REST API tab should follow the same principle.

Expected behavior

The REST API tab should display the array format that Cube recommends in its documentation, so integrators copy the reliable format.

Related

  • #7217 - Vue's query builder should use alternative order format
  • #773 / PR #973 - Original work to support ordered order specification

Contributor guide

Tech stack
javascripttypescriptreactrest api
Domain
frontendapidocumentation
Issue type
bug
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
JavaScriptReactREST API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the Playground's REST API tab component to find where the order parameter is rendered as an object. The file is likely under the playground directory (e.g., /playground/src/...). Change the output to use the array format: ["column", "direction"]. Review related issues #7217 and #773 and PR #973 for prior context on supporting the alternative order format. Ensure the change aligns with Cube's official REST API documentation.