Skip to content

Commit 682050c

Browse files
Yash02Rajputyuvrajjsingh0
authored andcommitted
fix: default list options to empty array when omitted
1 parent 4f5c8aa commit 682050c

55 files changed

Lines changed: 929 additions & 171 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export YELLOW := $(shell printf '\033[1;33m')
2828
export RED := $(shell printf '\033[0;31m')
2929
export NC := $(shell printf '\033[0m') # No Color
3030

31-
export SMITHY_MAVEN_REPOS = https://repo1.maven.org/maven2%7Chttps://sandbox.assets.juspay.in/smithy/m2
31+
export SMITHY_MAVEN_REPOS := https://repo1.maven.org/maven2|https://sandbox.assets.juspay.in/smithy/m2
3232

3333
# Docker detection
3434
HAS_DOCKER := $(shell command -v docker > /dev/null; echo $$?)

airborne-core-cli/bin.js

100755100644
File mode changed.

airborne-core-cli/index.js

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ program
125125
.option("--organisation <organisation>", "organisation parameter")
126126
.option("--token <token>", "Bearer token for authentication")
127127
.description(`
128-
Create application request operation:
128+
Create a new application inside an organisation. Pass the target organisation in the x-organisation header. Returns the created application and the caller's access levels. Requires a bearer token.:
129129
130130
Usage 1 - Individual options:
131131
$ airborne-core-cli CreateApplication \\
@@ -198,7 +198,7 @@ program
198198
.option("--application <application>", "application parameter")
199199
.option("--token <token>", "Bearer token for authentication")
200200
.description(`
201-
Create dimension request operation:
201+
Create a targeting dimension (standard or cohort) that releases can be targeted against. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
202202
203203
Usage 1 - Individual options:
204204
$ airborne-core-cli CreateDimension \\
@@ -290,7 +290,7 @@ program
290290
.option("--application <application>", "application parameter")
291291
.option("--token <token>", "Bearer token for authentication")
292292
.description(`
293-
Create file request operation:
293+
Register a file by URL, recording its metadata and assigning it a version. Pass the organisation and application in the x-organisation and x-application headers. Use this when the file is already hosted somewhere the server can reach; to upload the bytes directly, use UploadFile instead. Requires a bearer token.:
294294
295295
Usage 1 - Individual options:
296296
$ airborne-core-cli CreateFile \\
@@ -369,7 +369,7 @@ program
369369
.option("--name <name>", "name parameter")
370370
.option("--token <token>", "Bearer token for authentication")
371371
.description(`
372-
Create organisation request operation:
372+
Create a new organisation owned by the authenticated user. Returns the created organisation with its (initially empty) application list and the caller's access levels. Requires a bearer token.:
373373
374374
Usage 1 - Individual options:
375375
$ airborne-core-cli CreateOrganisation \\
@@ -383,7 +383,7 @@ Usage 3 - Mixed Usage:
383383
$ airborne-core-cli CreateOrganisation @params.json --name <value> --token <value>
384384
385385
Parameters:
386-
--name <string> (required)
386+
--name <string> (required) : Name for the new organisation.
387387
--token <string> (required) : Bearer token for authentication
388388
389389
`)
@@ -426,12 +426,12 @@ program
426426
.argument('[params_file]', 'JSON file containing all parameters (use @params.json format)')
427427
.option("--index <index>", "index parameter")
428428
.option("--tag <tag>", "tag parameter")
429-
.option("--files <files...>", "files parameter")
429+
.option("--files <files...>", "files parameter", [])
430430
.option("--organisation <organisation>", "organisation parameter")
431431
.option("--application <application>", "application parameter")
432432
.option("--token <token>", "Bearer token for authentication")
433433
.description(`
434-
Create package request operation:
434+
Create a package: an index file plus the set of files that make up an OTA bundle. Pass the organisation and application in the x-organisation and x-application headers. Returns the created package with its assigned version. Requires a bearer token.:
435435
436436
Usage 1 - Individual options:
437437
$ airborne-core-cli CreatePackage \\
@@ -450,7 +450,7 @@ Usage 3 - Mixed Usage:
450450
451451
Parameters:
452452
--index <string> (required) : Index file id
453-
--tag <string> (optional)
453+
--tag <string> (optional) : Optional tag to identify the package.
454454
--files [<string>] (required) : Space Separated file ids to be included in the package
455455
--organisation <string> (required) : Name of the organisation
456456
--application <string> (required) : Name of the application
@@ -506,12 +506,12 @@ program
506506
.option("--package_id <package_id>", "package_id parameter")
507507
.option("--package <package>", "package parameter")
508508
.option("--dimensions <dimensions>", "dimensions parameter")
509-
.option("--resources <resources...>", "resources parameter")
509+
.option("--resources <resources...>", "resources parameter", [])
510510
.option("--organisation <organisation>", "organisation parameter")
511511
.option("--application <application>", "application parameter")
512512
.option("--token <token>", "Bearer token for authentication")
513513
.description(`
514-
Create release request operation:
514+
Create a new release. A release points a package (and any resources) at a set of targeting dimensions; ramp it later to roll it out. Pass the organisation and application in the x-organisation and x-application headers. Returns the created release with its resolved config and package. Requires a bearer token.:
515515
516516
Usage 1 - Individual options:
517517
$ airborne-core-cli CreateRelease \\
@@ -597,7 +597,7 @@ program
597597
.option("--application <application>", "application parameter")
598598
.option("--token <token>", "Bearer token for authentication")
599599
.description(`
600-
Delete dimension request operation:
600+
Delete a dimension by name. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
601601
602602
Usage 1 - Individual options:
603603
$ airborne-core-cli DeleteDimension \\
@@ -665,7 +665,7 @@ program
665665
.option("--application <application>", "application parameter")
666666
.option("--token <token>", "Bearer token for authentication")
667667
.description(`
668-
Release request operation:
668+
Get a single release by its id, including its config, package, resources, targeting dimensions, and experiment details. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
669669
670670
Usage 1 - Individual options:
671671
$ airborne-core-cli GetRelease \\
@@ -731,7 +731,7 @@ program
731731

732732
.option("--token <token>", "Bearer token for authentication")
733733
.description(`
734-
Get user request operation:
734+
Get the authenticated user's profile, including the organisations they belong to and the caller's access level in each. Requires a bearer token.:
735735
736736
Usage 1 - Individual options:
737737
$ airborne-core-cli GetUser \\
@@ -800,7 +800,7 @@ program
800800
})
801801
.option("--token <token>", "Bearer token for authentication")
802802
.description(`
803-
List dimensions request operation:
803+
List the targeting dimensions defined for an application, in priority order, with pagination. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
804804
805805
Usage 1 - Individual options:
806806
$ airborne-core-cli ListDimensions \\
@@ -818,8 +818,8 @@ Usage 3 - Mixed Usage:
818818
Parameters:
819819
--organisation <string> (required) : Name of the organisation
820820
--application <string> (required) : Name of the application
821-
--page <integer> (optional)
822-
--count <integer> (optional)
821+
--page <integer> (optional) : Page number for pagination.
822+
--count <integer> (optional) : Number of dimensions per page.
823823
--token <string> (required) : Bearer token for authentication
824824
825825
`)
@@ -885,7 +885,7 @@ program
885885
.option("--application <application>", "application parameter")
886886
.option("--token <token>", "Bearer token for authentication")
887887
.description(`
888-
List file groups operation:
888+
List files grouped by path, so that all versions and tags of a file appear together. Supports pagination and optional search and tag filters. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
889889
890890
Usage 1 - Individual options:
891891
$ airborne-core-cli ListFileGroups \\
@@ -974,7 +974,7 @@ program
974974
.option("--application <application>", "application parameter")
975975
.option("--token <token>", "Bearer token for authentication")
976976
.description(`
977-
List files request operation:
977+
List files for an application, with pagination and optional search and tag filters. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
978978
979979
Usage 1 - Individual options:
980980
$ airborne-core-cli ListFiles \\
@@ -1046,7 +1046,7 @@ program
10461046

10471047
.option("--token <token>", "Bearer token for authentication")
10481048
.description(`
1049-
List organisations request operation:
1049+
List all organisations the authenticated user belongs to, along with their applications and the caller's access level in each. Requires a bearer token.:
10501050
10511051
Usage 1 - Individual options:
10521052
$ airborne-core-cli ListOrganisations \\
@@ -1121,7 +1121,7 @@ program
11211121
.option("--application <application>", "application parameter")
11221122
.option("--token <token>", "Bearer token for authentication")
11231123
.description(`
1124-
List packages request operation:
1124+
List packages for an application, with pagination and optional search by index file path. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
11251125
11261126
Usage 1 - Individual options:
11271127
$ airborne-core-cli ListPackages \\
@@ -1215,7 +1215,7 @@ program
12151215
.option("--application <application>", "application parameter")
12161216
.option("--token <token>", "Bearer token for authentication")
12171217
.description(`
1218-
List Releases request operation:
1218+
List releases for an application, with pagination and optional filtering by status or targeting dimension. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
12191219
12201220
Usage 1 - Individual options:
12211221
$ airborne-core-cli ListReleases \\
@@ -1289,7 +1289,7 @@ program
12891289
.option("--client_id <client_id>", "client_id parameter")
12901290
.option("--client_secret <client_secret>", "client_secret parameter")
12911291
.description(`
1292-
Login request operation:
1292+
Exchange user credentials (client_id and client_secret) for an access token and a refresh token. Public — no auth token required. Call this first, then send the returned access token as a bearer token on subsequent requests.:
12931293
12941294
Usage 1 - Individual options:
12951295
$ airborne-core-cli PostLogin \\
@@ -1352,7 +1352,7 @@ program
13521352
.option("--play_store_link <play_store_link>", "play_store_link parameter")
13531353
.option("--token <token>", "Bearer token for authentication")
13541354
.description(`
1355-
Request organisation request operation:
1355+
Submit a request to have an organisation provisioned (for onboarding flows that require manual approval), including contact details and store links. Returns a confirmation message. Requires a bearer token.:
13561356
13571357
Usage 1 - Individual options:
13581358
$ airborne-core-cli RequestOrganisation \\
@@ -1431,7 +1431,7 @@ program
14311431
.option("--application <application>", "application parameter")
14321432
.option("--token <token>", "Bearer token for authentication")
14331433
.description(`
1434-
Get release request operation:
1434+
Resolve and return the active release configuration for an application, given the caller's targeting dimensions. This is the endpoint the SDK calls at boot. Public — no auth token required.:
14351435
14361436
Usage 1 - Individual options:
14371437
$ airborne-core-cli ServeRelease \\
@@ -1446,8 +1446,8 @@ Usage 3 - Mixed Usage:
14461446
$ airborne-core-cli ServeRelease @params.json --organisation <value> --application <value> --token <value>
14471447
14481448
Parameters:
1449-
--organisation <string> (required)
1450-
--application <string> (required)
1449+
--organisation <string> (required) : Name of the organisation.
1450+
--application <string> (required) : Name of the application.
14511451
--token <string> (required) : Bearer token for authentication
14521452
14531453
`)
@@ -1494,7 +1494,7 @@ program
14941494
.option("--application <application>", "application parameter")
14951495
.option("--token <token>", "Bearer token for authentication")
14961496
.description(`
1497-
Get release v2 request operation:
1497+
Version 2 of the release-resolution endpoint: resolves and returns the active release configuration for an application based on the caller's targeting dimensions. This is the endpoint newer SDKs call at boot. Public — no auth token required.:
14981498
14991499
Usage 1 - Individual options:
15001500
$ airborne-core-cli ServeReleaseV2 \\
@@ -1509,8 +1509,8 @@ Usage 3 - Mixed Usage:
15091509
$ airborne-core-cli ServeReleaseV2 @params.json --organisation <value> --application <value> --token <value>
15101510
15111511
Parameters:
1512-
--organisation <string> (required)
1513-
--application <string> (required)
1512+
--organisation <string> (required) : Name of the organisation.
1513+
--application <string> (required) : Name of the application.
15141514
--token <string> (required) : Bearer token for authentication
15151515
15161516
`)
@@ -1566,7 +1566,7 @@ program
15661566
.option("--application <application>", "application parameter")
15671567
.option("--token <token>", "Bearer token for authentication")
15681568
.description(`
1569-
Update dimension request operation:
1569+
Update a dimension, identified by name in the path — for example to change its priority position. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
15701570
15711571
Usage 1 - Individual options:
15721572
$ airborne-core-cli UpdateDimension \\
@@ -1643,7 +1643,7 @@ program
16431643
.option("--application <application>", "application parameter")
16441644
.option("--token <token>", "Bearer token for authentication")
16451645
.description(`
1646-
Update file operation:
1646+
Update the tag of an existing file, identified by its file key in the path (a file path with a version or tag, e.g. "path/to/file@version:3" or "path/to/file@tag:prod"). Pass the organisation and application in the x-organisation and x-application headers. Returns the updated file. Requires a bearer token.:
16471647
16481648
Usage 1 - Individual options:
16491649
$ airborne-core-cli UpdateFile \\
@@ -1727,7 +1727,7 @@ program
17271727
.option("--application <application>", "application parameter")
17281728
.option("--token <token>", "Bearer token for authentication")
17291729
.description(`
1730-
Upload file request operation:
1730+
Upload a file's bytes directly as the request body and register it in one step. Send the raw file as the payload, with its Base64-encoded SHA-256 digest in the x-checksum header and the organisation and application in the x-organisation and x-application headers. Returns the created file. Requires a bearer token.:
17311731
17321732
Usage 1 - Individual options:
17331733
$ airborne-core-cli UploadFile \\

airborne_server_clients/javascript/sdk/dist-types/commands/CreateApplicationCommand.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ declare const CreateApplicationCommand_base: {
2727
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
2828
};
2929
/**
30-
* Create application request operation
30+
* Create a new application inside an organisation. Pass the target organisation in the x-organisation header. Returns the created application and the caller's access levels. Requires a bearer token.
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

airborne_server_clients/javascript/sdk/dist-types/commands/CreateDimensionCommand.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ declare const CreateDimensionCommand_base: {
2727
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
2828
};
2929
/**
30-
* Create dimension request operation
30+
* Create a targeting dimension (standard or cohort) that releases can be targeted against. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

airborne_server_clients/javascript/sdk/dist-types/commands/CreateFileCommand.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ declare const CreateFileCommand_base: {
2727
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
2828
};
2929
/**
30-
* Create file request operation
30+
* Register a file by URL, recording its metadata and assigning it a version. Pass the organisation and application in the x-organisation and x-application headers. Use this when the file is already hosted somewhere the server can reach; to upload the bytes directly, use UploadFile instead. Requires a bearer token.
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

airborne_server_clients/javascript/sdk/dist-types/commands/CreateOrganisationCommand.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ declare const CreateOrganisationCommand_base: {
2727
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
2828
};
2929
/**
30-
* Create organisation request operation
30+
* Create a new organisation owned by the authenticated user. Returns the created organisation with its (initially empty) application list and the caller's access levels. Requires a bearer token.
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

airborne_server_clients/javascript/sdk/dist-types/commands/CreatePackageCommand.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ declare const CreatePackageCommand_base: {
2727
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
2828
};
2929
/**
30-
* Create package request operation
30+
* Create a package: an index file plus the set of files that make up an OTA bundle. Pass the organisation and application in the x-organisation and x-application headers. Returns the created package with its assigned version. Requires a bearer token.
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

airborne_server_clients/javascript/sdk/dist-types/commands/CreateReleaseCommand.d.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ declare const CreateReleaseCommand_base: {
2727
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
2828
};
2929
/**
30-
* Create release request operation
30+
* Create a new release. A release points a package (and any resources) at a set of targeting dimensions; ramp it later to roll it out. Pass the organisation and application in the x-organisation and x-application headers. Returns the created release with its resolved config and package. Requires a bearer token.
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript
@@ -79,20 +79,23 @@ declare const CreateReleaseCommand_base: {
7979
* // file_path: "STRING_VALUE",
8080
* // url: "STRING_VALUE",
8181
* // checksum: "STRING_VALUE",
82+
* // size: Number("long"),
8283
* // },
8384
* // properties: "DOCUMENT_VALUE",
8485
* // important: [ // ServeFileList
8586
* // {
8687
* // file_path: "STRING_VALUE",
8788
* // url: "STRING_VALUE",
8889
* // checksum: "STRING_VALUE",
90+
* // size: Number("long"),
8991
* // },
9092
* // ],
9193
* // lazy: [
9294
* // {
9395
* // file_path: "STRING_VALUE",
9496
* // url: "STRING_VALUE",
9597
* // checksum: "STRING_VALUE",
98+
* // size: Number("long"),
9699
* // },
97100
* // ],
98101
* // },

airborne_server_clients/javascript/sdk/dist-types/commands/DeleteDimensionCommand.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ declare const DeleteDimensionCommand_base: {
2727
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
2828
};
2929
/**
30-
* Delete dimension request operation
30+
* Delete a dimension by name. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

0 commit comments

Comments
 (0)