Skip to content

Commit 789df72

Browse files
Merge pull request #162 from Dorthu/cli-better-backups
Added new CLI-specific parameters to backups endpoint
2 parents 05bc59e + 0ac7918 commit 789df72

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,6 @@ Attribute | Location | Type | Supported By | Explanation
4747
`x-linode-cli-skip` | method | boolean | linode-cli | If true, the CLI will not expose this action.
4848
`x-linode-redoc-load-ids`| operation | boolean | If true, ReDoc will load this path and print a bulleted list of IDs. This only works on public collections.
4949
`x-linode-ref-name`| keyword | string | [Linode Developer's Site](https://github.com/linode/developers) | Provides a mechanism by which the Developer's site can generate a dropdown menu with an Object's name when using the `oneOf` keyword with a `discriminator`. **Note**: This front end functionality is currently being developed.
50+
`x-linode-cli-rows`| media type | array | A list of JSON paths where the CLI can find the value it should treat as table rows. Only needed for irregular endpoints.
51+
`x-linode-cli-use-schema` | media type | schema or $ref | The schema the CLI should use when showing a row for this response. Use with `x-linode-cli-rows`.
52+
`x-linode-cli-nested-list` | media type | string | The name of the property defined by this response body's schema that is a nested list. Items in the list will be broken out into rows in the CLI's output.

openapi.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3326,6 +3326,12 @@ paths:
33263326
description: A collection of the specified Linode's available backups.
33273327
content:
33283328
application/json:
3329+
x-linode-cli-rows:
3330+
- automatic
3331+
- snapshot.current
3332+
- snapshot.in_progress
3333+
x-linode-cli-use-schema:
3334+
$ref: '#/components/schemas/Backup'
33293335
schema:
33303336
type: object
33313337
properties:
@@ -6263,6 +6269,18 @@ paths:
62636269
description: Returns an array of all Pools in this Kubernetes cluster.
62646270
content:
62656271
application/json:
6272+
x-linode-cli-nested-list: linodes
6273+
x-linode-cli-use-schema:
6274+
type: object
6275+
properties:
6276+
id:
6277+
x-linode-cli-display: 1
6278+
type:
6279+
x-linode-cli-display: 2
6280+
linodes.id:
6281+
x-linode-cli-display: 3
6282+
linodes.status:
6283+
x-linode-cli-display: 4
62666284
schema:
62676285
type: object
62686286
properties:

0 commit comments

Comments
 (0)