Skip to content

Add common cat API parameters for unit rendering #5297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add common cat API parameters for unit rendering #5297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions specification/_spec_utils/behaviors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,28 @@ export interface CommonCatQueryParameters {
* @server_default false
*/
v?: boolean
/**
* Sets the units for columns that contain a byte-size value.
* Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
* If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
* If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
* Values that are not an exact multiple of the chosen unit are rounded down.
*/
bytes?: 'b' | 'kb' | 'mb' | 'gb' | 'tb' | 'pb'
/**
* Sets the units for columns that contain a size value which is not a byte-size value.
* If omitted, size values are rendered with a suffix such as `k`, `m`, or `g`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
* If given, size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
* Values that are not an exact multiple of the chosen unit are rounded down.
*/
size?: '' | 'k' | 'm' | 'g' | 't' | 'p'
/**
* Sets the units for columns that contain a time duration.
* If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
* If given, time duration values are rendered as an integer with no suffix.
* Values that are not an exact multiple of the chosen unit are rounded down.
*/
time?: 'nanos' | 'micros' | 'ms' | 's' | 'm' | 'h' | 'd'
}

/**
Expand Down
Loading