From 8fff4c6068842de085fffd87e6041f550ebdee90 Mon Sep 17 00:00:00 2001 From: Quentin Dufour Date: Sat, 12 Nov 2022 23:50:53 +0100 Subject: [PATCH] change module name --- build.gradle | 1 + javascript/.openapi-generator/FILES | 35 ----- javascript/README.md | 120 +++++++++--------- javascript/docs/AddKeyRequest.md | 2 +- javascript/docs/AddNode200ResponseInner.md | 2 +- javascript/docs/AllowBucketKeyRequest.md | 2 +- .../docs/AllowBucketKeyRequestPermissions.md | 2 +- javascript/docs/BucketApi.md | 82 ++++++------ javascript/docs/BucketInfo.md | 2 +- javascript/docs/BucketInfoQuotas.md | 2 +- javascript/docs/BucketInfoWebsiteConfig.md | 2 +- javascript/docs/BucketKeyInfo.md | 2 +- javascript/docs/ClusterLayout.md | 2 +- javascript/docs/CreateBucketRequest.md | 2 +- .../docs/CreateBucketRequestLocalAlias.md | 2 +- .../CreateBucketRequestLocalAliasAllow.md | 2 +- javascript/docs/GetNodes200Response.md | 2 +- javascript/docs/ImportKeyRequest.md | 2 +- javascript/docs/KeyApi.md | 50 ++++---- javascript/docs/KeyInfo.md | 2 +- javascript/docs/KeyInfoBucketsInner.md | 2 +- .../docs/KeyInfoBucketsInnerPermissions.md | 2 +- javascript/docs/KeyInfoPermissions.md | 2 +- javascript/docs/LayoutApi.md | 32 ++--- javascript/docs/LayoutVersion.md | 2 +- .../docs/ListBuckets200ResponseInner.md | 2 +- ...uckets200ResponseInnerLocalAliasesInner.md | 2 +- javascript/docs/ListKeys200ResponseInner.md | 2 +- javascript/docs/NodeClusterInfo.md | 2 +- javascript/docs/NodeNetworkInfo.md | 2 +- javascript/docs/NodesApi.md | 14 +- javascript/docs/UpdateBucketRequest.md | 2 +- javascript/docs/UpdateBucketRequestQuotas.md | 2 +- .../docs/UpdateBucketRequestWebsiteAccess.md | 2 +- javascript/docs/UpdateKeyRequest.md | 2 +- javascript/docs/UpdateKeyRequestAllow.md | 2 +- javascript/docs/UpdateKeyRequestDeny.md | 2 +- javascript/src/index.js | 10 +- 38 files changed, 185 insertions(+), 219 deletions(-) diff --git a/build.gradle b/build.gradle index c4d4100..91120ba 100644 --- a/build.gradle +++ b/build.gradle @@ -34,6 +34,7 @@ task buildJavascriptClient(type: org.openapitools.generator.gradle.plugin.tasks. outputDir = "$rootDir/javascript" configOptions = [ packageName: "garage", + moduleName: "garage", packageVersion: "0.8.0", ] } diff --git a/javascript/.openapi-generator/FILES b/javascript/.openapi-generator/FILES index f7b87e8..82ee1a4 100644 --- a/javascript/.openapi-generator/FILES +++ b/javascript/.openapi-generator/FILES @@ -1,6 +1,5 @@ .babelrc .gitignore -.openapi-generator-ignore .travis.yml README.md docs/AddKeyRequest.md @@ -76,37 +75,3 @@ src/model/UpdateBucketRequestWebsiteAccess.js src/model/UpdateKeyRequest.js src/model/UpdateKeyRequestAllow.js src/model/UpdateKeyRequestDeny.js -test/api/BucketApi.spec.js -test/api/KeyApi.spec.js -test/api/LayoutApi.spec.js -test/api/NodesApi.spec.js -test/model/AddKeyRequest.spec.js -test/model/AddNode200ResponseInner.spec.js -test/model/AllowBucketKeyRequest.spec.js -test/model/AllowBucketKeyRequestPermissions.spec.js -test/model/BucketInfo.spec.js -test/model/BucketInfoQuotas.spec.js -test/model/BucketInfoWebsiteConfig.spec.js -test/model/BucketKeyInfo.spec.js -test/model/ClusterLayout.spec.js -test/model/CreateBucketRequest.spec.js -test/model/CreateBucketRequestLocalAlias.spec.js -test/model/CreateBucketRequestLocalAliasAllow.spec.js -test/model/GetNodes200Response.spec.js -test/model/ImportKeyRequest.spec.js -test/model/KeyInfo.spec.js -test/model/KeyInfoBucketsInner.spec.js -test/model/KeyInfoBucketsInnerPermissions.spec.js -test/model/KeyInfoPermissions.spec.js -test/model/LayoutVersion.spec.js -test/model/ListBuckets200ResponseInner.spec.js -test/model/ListBuckets200ResponseInnerLocalAliasesInner.spec.js -test/model/ListKeys200ResponseInner.spec.js -test/model/NodeClusterInfo.spec.js -test/model/NodeNetworkInfo.spec.js -test/model/UpdateBucketRequest.spec.js -test/model/UpdateBucketRequestQuotas.spec.js -test/model/UpdateBucketRequestWebsiteAccess.spec.js -test/model/UpdateKeyRequest.spec.js -test/model/UpdateKeyRequestAllow.spec.js -test/model/UpdateKeyRequestDeny.spec.js diff --git a/javascript/README.md b/javascript/README.md index 05a037a..0edb76f 100644 --- a/javascript/README.md +++ b/javascript/README.md @@ -1,6 +1,6 @@ # garage_administration_api_v0garage_v0_8_0 -GarageAdministrationApiV0garageV080 - JavaScript client for garage_administration_api_v0garage_v0_8_0 +garage - JavaScript client for garage_administration_api_v0garage_v0_8_0 Administrate your Garage cluster programatically, including status, layout, keys, buckets, and maintainance tasks. *Disclaimer: The API is not stable yet, hence its v0 tag. The API can change at any time, and changes can include breaking backward compatibility. Read the changelog and upgrade your scripts before upgrading. Additionnaly, this specification is very early stage and can contain bugs, especially on error return codes/types that are not tested yet. Do not expect a well finished and polished product!* @@ -101,15 +101,15 @@ module: { Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript -var GarageAdministrationApiV0garageV080 = require('garage_administration_api_v0garage_v0_8_0'); +var garage = require('garage_administration_api_v0garage_v0_8_0'); -var defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +var defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth var bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -var api = new GarageAdministrationApiV0garageV080.BucketApi() -var allowBucketKeyRequest = new GarageAdministrationApiV0garageV080.AllowBucketKeyRequest(); // {AllowBucketKeyRequest} Aliases to put on the new bucket +var api = new garage.BucketApi() +var allowBucketKeyRequest = new garage.AllowBucketKeyRequest(); // {AllowBucketKeyRequest} Aliases to put on the new bucket var callback = function(error, data, response) { if (error) { console.error(error); @@ -127,65 +127,65 @@ All URIs are relative to *http://localhost:3903/v0* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*GarageAdministrationApiV0garageV080.BucketApi* | [**allowBucketKey**](docs/BucketApi.md#allowBucketKey) | **POST** /bucket/allow | Allow key -*GarageAdministrationApiV0garageV080.BucketApi* | [**createBucket**](docs/BucketApi.md#createBucket) | **POST** /bucket | Create a bucket -*GarageAdministrationApiV0garageV080.BucketApi* | [**deleteBucket**](docs/BucketApi.md#deleteBucket) | **DELETE** /bucket?id={bucket_id} | Delete a bucket -*GarageAdministrationApiV0garageV080.BucketApi* | [**deleteBucketGlobalAlias**](docs/BucketApi.md#deleteBucketGlobalAlias) | **DELETE** /bucket/alias/global | Delete a global alias -*GarageAdministrationApiV0garageV080.BucketApi* | [**deleteBucketLocalAlias**](docs/BucketApi.md#deleteBucketLocalAlias) | **DELETE** /bucket/alias/local | Delete a local alias -*GarageAdministrationApiV0garageV080.BucketApi* | [**denyBucketKey**](docs/BucketApi.md#denyBucketKey) | **POST** /bucket/deny | Deny key -*GarageAdministrationApiV0garageV080.BucketApi* | [**findBucketInfo**](docs/BucketApi.md#findBucketInfo) | **GET** /bucket?globalAlias={alias} | Find a bucket -*GarageAdministrationApiV0garageV080.BucketApi* | [**getBucketInfo**](docs/BucketApi.md#getBucketInfo) | **GET** /bucket?id={bucket_id} | Get a bucket -*GarageAdministrationApiV0garageV080.BucketApi* | [**listBuckets**](docs/BucketApi.md#listBuckets) | **GET** /bucket | List all buckets -*GarageAdministrationApiV0garageV080.BucketApi* | [**putBucketGlobalAlias**](docs/BucketApi.md#putBucketGlobalAlias) | **PUT** /bucket/alias/global | Add a global alias -*GarageAdministrationApiV0garageV080.BucketApi* | [**putBucketLocalAlias**](docs/BucketApi.md#putBucketLocalAlias) | **PUT** /bucket/alias/local | Add a local alias -*GarageAdministrationApiV0garageV080.BucketApi* | [**updateBucket**](docs/BucketApi.md#updateBucket) | **PUT** /bucket?id={bucket_id} | Update a bucket -*GarageAdministrationApiV0garageV080.KeyApi* | [**addKey**](docs/KeyApi.md#addKey) | **POST** /key | Create a new API key -*GarageAdministrationApiV0garageV080.KeyApi* | [**deleteKey**](docs/KeyApi.md#deleteKey) | **DELETE** /key?id={access_key} | Delete a key -*GarageAdministrationApiV0garageV080.KeyApi* | [**getKey**](docs/KeyApi.md#getKey) | **GET** /key?id={access_key} | Get key information -*GarageAdministrationApiV0garageV080.KeyApi* | [**importKey**](docs/KeyApi.md#importKey) | **POST** /key/import | Import an existing key -*GarageAdministrationApiV0garageV080.KeyApi* | [**listKeys**](docs/KeyApi.md#listKeys) | **GET** /key | List all keys -*GarageAdministrationApiV0garageV080.KeyApi* | [**searchKey**](docs/KeyApi.md#searchKey) | **GET** /key?search={pattern} | Select key by pattern -*GarageAdministrationApiV0garageV080.KeyApi* | [**updateKey**](docs/KeyApi.md#updateKey) | **POST** /key?id={access_key} | Update a key -*GarageAdministrationApiV0garageV080.LayoutApi* | [**addLayout**](docs/LayoutApi.md#addLayout) | **POST** /layout | Send modifications to the cluster layout -*GarageAdministrationApiV0garageV080.LayoutApi* | [**applyLayout**](docs/LayoutApi.md#applyLayout) | **POST** /layout/apply | Apply staged layout -*GarageAdministrationApiV0garageV080.LayoutApi* | [**getLayout**](docs/LayoutApi.md#getLayout) | **GET** /layout | Details on the current and staged layout -*GarageAdministrationApiV0garageV080.LayoutApi* | [**revertLayout**](docs/LayoutApi.md#revertLayout) | **POST** /layout/revert | Clear staged layout -*GarageAdministrationApiV0garageV080.NodesApi* | [**addNode**](docs/NodesApi.md#addNode) | **POST** /connect | Connect target node to other Garage nodes -*GarageAdministrationApiV0garageV080.NodesApi* | [**getNodes**](docs/NodesApi.md#getNodes) | **GET** /status | Status of this node and other nodes in the cluster +*garage.BucketApi* | [**allowBucketKey**](docs/BucketApi.md#allowBucketKey) | **POST** /bucket/allow | Allow key +*garage.BucketApi* | [**createBucket**](docs/BucketApi.md#createBucket) | **POST** /bucket | Create a bucket +*garage.BucketApi* | [**deleteBucket**](docs/BucketApi.md#deleteBucket) | **DELETE** /bucket?id={bucket_id} | Delete a bucket +*garage.BucketApi* | [**deleteBucketGlobalAlias**](docs/BucketApi.md#deleteBucketGlobalAlias) | **DELETE** /bucket/alias/global | Delete a global alias +*garage.BucketApi* | [**deleteBucketLocalAlias**](docs/BucketApi.md#deleteBucketLocalAlias) | **DELETE** /bucket/alias/local | Delete a local alias +*garage.BucketApi* | [**denyBucketKey**](docs/BucketApi.md#denyBucketKey) | **POST** /bucket/deny | Deny key +*garage.BucketApi* | [**findBucketInfo**](docs/BucketApi.md#findBucketInfo) | **GET** /bucket?globalAlias={alias} | Find a bucket +*garage.BucketApi* | [**getBucketInfo**](docs/BucketApi.md#getBucketInfo) | **GET** /bucket?id={bucket_id} | Get a bucket +*garage.BucketApi* | [**listBuckets**](docs/BucketApi.md#listBuckets) | **GET** /bucket | List all buckets +*garage.BucketApi* | [**putBucketGlobalAlias**](docs/BucketApi.md#putBucketGlobalAlias) | **PUT** /bucket/alias/global | Add a global alias +*garage.BucketApi* | [**putBucketLocalAlias**](docs/BucketApi.md#putBucketLocalAlias) | **PUT** /bucket/alias/local | Add a local alias +*garage.BucketApi* | [**updateBucket**](docs/BucketApi.md#updateBucket) | **PUT** /bucket?id={bucket_id} | Update a bucket +*garage.KeyApi* | [**addKey**](docs/KeyApi.md#addKey) | **POST** /key | Create a new API key +*garage.KeyApi* | [**deleteKey**](docs/KeyApi.md#deleteKey) | **DELETE** /key?id={access_key} | Delete a key +*garage.KeyApi* | [**getKey**](docs/KeyApi.md#getKey) | **GET** /key?id={access_key} | Get key information +*garage.KeyApi* | [**importKey**](docs/KeyApi.md#importKey) | **POST** /key/import | Import an existing key +*garage.KeyApi* | [**listKeys**](docs/KeyApi.md#listKeys) | **GET** /key | List all keys +*garage.KeyApi* | [**searchKey**](docs/KeyApi.md#searchKey) | **GET** /key?search={pattern} | Select key by pattern +*garage.KeyApi* | [**updateKey**](docs/KeyApi.md#updateKey) | **POST** /key?id={access_key} | Update a key +*garage.LayoutApi* | [**addLayout**](docs/LayoutApi.md#addLayout) | **POST** /layout | Send modifications to the cluster layout +*garage.LayoutApi* | [**applyLayout**](docs/LayoutApi.md#applyLayout) | **POST** /layout/apply | Apply staged layout +*garage.LayoutApi* | [**getLayout**](docs/LayoutApi.md#getLayout) | **GET** /layout | Details on the current and staged layout +*garage.LayoutApi* | [**revertLayout**](docs/LayoutApi.md#revertLayout) | **POST** /layout/revert | Clear staged layout +*garage.NodesApi* | [**addNode**](docs/NodesApi.md#addNode) | **POST** /connect | Connect target node to other Garage nodes +*garage.NodesApi* | [**getNodes**](docs/NodesApi.md#getNodes) | **GET** /status | Status of this node and other nodes in the cluster ## Documentation for Models - - [GarageAdministrationApiV0garageV080.AddKeyRequest](docs/AddKeyRequest.md) - - [GarageAdministrationApiV0garageV080.AddNode200ResponseInner](docs/AddNode200ResponseInner.md) - - [GarageAdministrationApiV0garageV080.AllowBucketKeyRequest](docs/AllowBucketKeyRequest.md) - - [GarageAdministrationApiV0garageV080.AllowBucketKeyRequestPermissions](docs/AllowBucketKeyRequestPermissions.md) - - [GarageAdministrationApiV0garageV080.BucketInfo](docs/BucketInfo.md) - - [GarageAdministrationApiV0garageV080.BucketInfoQuotas](docs/BucketInfoQuotas.md) - - [GarageAdministrationApiV0garageV080.BucketInfoWebsiteConfig](docs/BucketInfoWebsiteConfig.md) - - [GarageAdministrationApiV0garageV080.BucketKeyInfo](docs/BucketKeyInfo.md) - - [GarageAdministrationApiV0garageV080.ClusterLayout](docs/ClusterLayout.md) - - [GarageAdministrationApiV0garageV080.CreateBucketRequest](docs/CreateBucketRequest.md) - - [GarageAdministrationApiV0garageV080.CreateBucketRequestLocalAlias](docs/CreateBucketRequestLocalAlias.md) - - [GarageAdministrationApiV0garageV080.CreateBucketRequestLocalAliasAllow](docs/CreateBucketRequestLocalAliasAllow.md) - - [GarageAdministrationApiV0garageV080.GetNodes200Response](docs/GetNodes200Response.md) - - [GarageAdministrationApiV0garageV080.ImportKeyRequest](docs/ImportKeyRequest.md) - - [GarageAdministrationApiV0garageV080.KeyInfo](docs/KeyInfo.md) - - [GarageAdministrationApiV0garageV080.KeyInfoBucketsInner](docs/KeyInfoBucketsInner.md) - - [GarageAdministrationApiV0garageV080.KeyInfoBucketsInnerPermissions](docs/KeyInfoBucketsInnerPermissions.md) - - [GarageAdministrationApiV0garageV080.KeyInfoPermissions](docs/KeyInfoPermissions.md) - - [GarageAdministrationApiV0garageV080.LayoutVersion](docs/LayoutVersion.md) - - [GarageAdministrationApiV0garageV080.ListBuckets200ResponseInner](docs/ListBuckets200ResponseInner.md) - - [GarageAdministrationApiV0garageV080.ListBuckets200ResponseInnerLocalAliasesInner](docs/ListBuckets200ResponseInnerLocalAliasesInner.md) - - [GarageAdministrationApiV0garageV080.ListKeys200ResponseInner](docs/ListKeys200ResponseInner.md) - - [GarageAdministrationApiV0garageV080.NodeClusterInfo](docs/NodeClusterInfo.md) - - [GarageAdministrationApiV0garageV080.NodeNetworkInfo](docs/NodeNetworkInfo.md) - - [GarageAdministrationApiV0garageV080.UpdateBucketRequest](docs/UpdateBucketRequest.md) - - [GarageAdministrationApiV0garageV080.UpdateBucketRequestQuotas](docs/UpdateBucketRequestQuotas.md) - - [GarageAdministrationApiV0garageV080.UpdateBucketRequestWebsiteAccess](docs/UpdateBucketRequestWebsiteAccess.md) - - [GarageAdministrationApiV0garageV080.UpdateKeyRequest](docs/UpdateKeyRequest.md) - - [GarageAdministrationApiV0garageV080.UpdateKeyRequestAllow](docs/UpdateKeyRequestAllow.md) - - [GarageAdministrationApiV0garageV080.UpdateKeyRequestDeny](docs/UpdateKeyRequestDeny.md) + - [garage.AddKeyRequest](docs/AddKeyRequest.md) + - [garage.AddNode200ResponseInner](docs/AddNode200ResponseInner.md) + - [garage.AllowBucketKeyRequest](docs/AllowBucketKeyRequest.md) + - [garage.AllowBucketKeyRequestPermissions](docs/AllowBucketKeyRequestPermissions.md) + - [garage.BucketInfo](docs/BucketInfo.md) + - [garage.BucketInfoQuotas](docs/BucketInfoQuotas.md) + - [garage.BucketInfoWebsiteConfig](docs/BucketInfoWebsiteConfig.md) + - [garage.BucketKeyInfo](docs/BucketKeyInfo.md) + - [garage.ClusterLayout](docs/ClusterLayout.md) + - [garage.CreateBucketRequest](docs/CreateBucketRequest.md) + - [garage.CreateBucketRequestLocalAlias](docs/CreateBucketRequestLocalAlias.md) + - [garage.CreateBucketRequestLocalAliasAllow](docs/CreateBucketRequestLocalAliasAllow.md) + - [garage.GetNodes200Response](docs/GetNodes200Response.md) + - [garage.ImportKeyRequest](docs/ImportKeyRequest.md) + - [garage.KeyInfo](docs/KeyInfo.md) + - [garage.KeyInfoBucketsInner](docs/KeyInfoBucketsInner.md) + - [garage.KeyInfoBucketsInnerPermissions](docs/KeyInfoBucketsInnerPermissions.md) + - [garage.KeyInfoPermissions](docs/KeyInfoPermissions.md) + - [garage.LayoutVersion](docs/LayoutVersion.md) + - [garage.ListBuckets200ResponseInner](docs/ListBuckets200ResponseInner.md) + - [garage.ListBuckets200ResponseInnerLocalAliasesInner](docs/ListBuckets200ResponseInnerLocalAliasesInner.md) + - [garage.ListKeys200ResponseInner](docs/ListKeys200ResponseInner.md) + - [garage.NodeClusterInfo](docs/NodeClusterInfo.md) + - [garage.NodeNetworkInfo](docs/NodeNetworkInfo.md) + - [garage.UpdateBucketRequest](docs/UpdateBucketRequest.md) + - [garage.UpdateBucketRequestQuotas](docs/UpdateBucketRequestQuotas.md) + - [garage.UpdateBucketRequestWebsiteAccess](docs/UpdateBucketRequestWebsiteAccess.md) + - [garage.UpdateKeyRequest](docs/UpdateKeyRequest.md) + - [garage.UpdateKeyRequestAllow](docs/UpdateKeyRequestAllow.md) + - [garage.UpdateKeyRequestDeny](docs/UpdateKeyRequestDeny.md) ## Documentation for Authorization diff --git a/javascript/docs/AddKeyRequest.md b/javascript/docs/AddKeyRequest.md index 2695200..558e1b7 100644 --- a/javascript/docs/AddKeyRequest.md +++ b/javascript/docs/AddKeyRequest.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.AddKeyRequest +# garage.AddKeyRequest ## Properties diff --git a/javascript/docs/AddNode200ResponseInner.md b/javascript/docs/AddNode200ResponseInner.md index ee90d4d..1d70a1d 100644 --- a/javascript/docs/AddNode200ResponseInner.md +++ b/javascript/docs/AddNode200ResponseInner.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.AddNode200ResponseInner +# garage.AddNode200ResponseInner ## Properties diff --git a/javascript/docs/AllowBucketKeyRequest.md b/javascript/docs/AllowBucketKeyRequest.md index 9192515..815c9a5 100644 --- a/javascript/docs/AllowBucketKeyRequest.md +++ b/javascript/docs/AllowBucketKeyRequest.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.AllowBucketKeyRequest +# garage.AllowBucketKeyRequest ## Properties diff --git a/javascript/docs/AllowBucketKeyRequestPermissions.md b/javascript/docs/AllowBucketKeyRequestPermissions.md index b8fd08b..e8f8357 100644 --- a/javascript/docs/AllowBucketKeyRequestPermissions.md +++ b/javascript/docs/AllowBucketKeyRequestPermissions.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.AllowBucketKeyRequestPermissions +# garage.AllowBucketKeyRequestPermissions ## Properties diff --git a/javascript/docs/BucketApi.md b/javascript/docs/BucketApi.md index a5905f9..5251168 100644 --- a/javascript/docs/BucketApi.md +++ b/javascript/docs/BucketApi.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.BucketApi +# garage.BucketApi All URIs are relative to *http://localhost:3903/v0* @@ -30,14 +30,14 @@ Allow key ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); -let allowBucketKeyRequest = new GarageAdministrationApiV0garageV080.AllowBucketKeyRequest(); // AllowBucketKeyRequest | Aliases to put on the new bucket +let apiInstance = new garage.BucketApi(); +let allowBucketKeyRequest = new garage.AllowBucketKeyRequest(); // AllowBucketKeyRequest | Aliases to put on the new bucket apiInstance.allowBucketKey(allowBucketKeyRequest, (error, data, response) => { if (error) { console.error(error); @@ -79,14 +79,14 @@ Creates a new bucket, either with a global alias, a local one, or no alias at al ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); -let createBucketRequest = new GarageAdministrationApiV0garageV080.CreateBucketRequest(); // CreateBucketRequest | Aliases to put on the new bucket +let apiInstance = new garage.BucketApi(); +let createBucketRequest = new garage.CreateBucketRequest(); // CreateBucketRequest | Aliases to put on the new bucket apiInstance.createBucket(createBucketRequest, (error, data, response) => { if (error) { console.error(error); @@ -128,13 +128,13 @@ Delete a bucket.Deletes a storage bucket. A bucket cannot be deleted if it is no ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); +let apiInstance = new garage.BucketApi(); let bucketId = b4018dc61b27ccb5c64ec1b24f53454bbbd180697c758c4d47a22a8921864a87; // String | The exact bucket identifier, a 32 bytes hexadecimal string apiInstance.deleteBucket(bucketId, (error, data, response) => { if (error) { @@ -177,13 +177,13 @@ Delete a global alias from the target bucket ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); +let apiInstance = new garage.BucketApi(); let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String | let alias = my_documents; // String | apiInstance.deleteBucketGlobalAlias(id, alias, (error, data, response) => { @@ -228,13 +228,13 @@ Delete a local alias, bound to specified account, from the target bucket ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); +let apiInstance = new garage.BucketApi(); let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String | let accessKeyId = GK31c2f218a2e44f485b94239e; // String | let alias = my_documents; // String | @@ -281,14 +281,14 @@ Deny key ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); -let allowBucketKeyRequest = new GarageAdministrationApiV0garageV080.AllowBucketKeyRequest(); // AllowBucketKeyRequest | Aliases to put on the new bucket +let apiInstance = new garage.BucketApi(); +let allowBucketKeyRequest = new garage.AllowBucketKeyRequest(); // AllowBucketKeyRequest | Aliases to put on the new bucket apiInstance.denyBucketKey(allowBucketKeyRequest, (error, data, response) => { if (error) { console.error(error); @@ -330,13 +330,13 @@ Find a bucket by its global alias ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); +let apiInstance = new garage.BucketApi(); let alias = my_documents; // String | The exact global alias of one of the existing buckets apiInstance.findBucketInfo(alias, (error, data, response) => { if (error) { @@ -379,13 +379,13 @@ Given a bucket identifier, get its information. It includes its aliases, its web ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); +let apiInstance = new garage.BucketApi(); let bucketId = b4018dc61b27ccb5c64ec1b24f53454bbbd180697c758c4d47a22a8921864a87; // String | The exact bucket identifier, a 32 bytes hexadecimal string apiInstance.getBucketInfo(bucketId, (error, data, response) => { if (error) { @@ -428,13 +428,13 @@ List all the buckets on the cluster with their UUID and their global and local a ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); +let apiInstance = new garage.BucketApi(); apiInstance.listBuckets((error, data, response) => { if (error) { console.error(error); @@ -473,13 +473,13 @@ Add a global alias to the target bucket ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); +let apiInstance = new garage.BucketApi(); let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String | let alias = my_documents; // String | apiInstance.putBucketGlobalAlias(id, alias, (error, data, response) => { @@ -524,13 +524,13 @@ Add a local alias, bound to specified account, to the target bucket ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); +let apiInstance = new garage.BucketApi(); let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String | let accessKeyId = GK31c2f218a2e44f485b94239e; // String | let alias = my_documents; // String | @@ -577,15 +577,15 @@ All fields (`websiteAccess` and `quotas`) are optionnal. If ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); +let apiInstance = new garage.BucketApi(); let bucketId = b4018dc61b27ccb5c64ec1b24f53454bbbd180697c758c4d47a22a8921864a87; // String | The exact bucket identifier, a 32 bytes hexadecimal string -let updateBucketRequest = new GarageAdministrationApiV0garageV080.UpdateBucketRequest(); // UpdateBucketRequest | Requested changes on the bucket. Both root fields are optionals. +let updateBucketRequest = new garage.UpdateBucketRequest(); // UpdateBucketRequest | Requested changes on the bucket. Both root fields are optionals. apiInstance.updateBucket(bucketId, updateBucketRequest, (error, data, response) => { if (error) { console.error(error); diff --git a/javascript/docs/BucketInfo.md b/javascript/docs/BucketInfo.md index 1f1ec0f..85742e1 100644 --- a/javascript/docs/BucketInfo.md +++ b/javascript/docs/BucketInfo.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.BucketInfo +# garage.BucketInfo ## Properties diff --git a/javascript/docs/BucketInfoQuotas.md b/javascript/docs/BucketInfoQuotas.md index c6348f3..3a7ebf3 100644 --- a/javascript/docs/BucketInfoQuotas.md +++ b/javascript/docs/BucketInfoQuotas.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.BucketInfoQuotas +# garage.BucketInfoQuotas ## Properties diff --git a/javascript/docs/BucketInfoWebsiteConfig.md b/javascript/docs/BucketInfoWebsiteConfig.md index a3c5ba1..f9caf33 100644 --- a/javascript/docs/BucketInfoWebsiteConfig.md +++ b/javascript/docs/BucketInfoWebsiteConfig.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.BucketInfoWebsiteConfig +# garage.BucketInfoWebsiteConfig ## Properties diff --git a/javascript/docs/BucketKeyInfo.md b/javascript/docs/BucketKeyInfo.md index e367133..0ce8851 100644 --- a/javascript/docs/BucketKeyInfo.md +++ b/javascript/docs/BucketKeyInfo.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.BucketKeyInfo +# garage.BucketKeyInfo ## Properties diff --git a/javascript/docs/ClusterLayout.md b/javascript/docs/ClusterLayout.md index 5533640..7918431 100644 --- a/javascript/docs/ClusterLayout.md +++ b/javascript/docs/ClusterLayout.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.ClusterLayout +# garage.ClusterLayout ## Properties diff --git a/javascript/docs/CreateBucketRequest.md b/javascript/docs/CreateBucketRequest.md index f138478..0d24199 100644 --- a/javascript/docs/CreateBucketRequest.md +++ b/javascript/docs/CreateBucketRequest.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.CreateBucketRequest +# garage.CreateBucketRequest ## Properties diff --git a/javascript/docs/CreateBucketRequestLocalAlias.md b/javascript/docs/CreateBucketRequestLocalAlias.md index d0b5f9f..d9d7289 100644 --- a/javascript/docs/CreateBucketRequestLocalAlias.md +++ b/javascript/docs/CreateBucketRequestLocalAlias.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.CreateBucketRequestLocalAlias +# garage.CreateBucketRequestLocalAlias ## Properties diff --git a/javascript/docs/CreateBucketRequestLocalAliasAllow.md b/javascript/docs/CreateBucketRequestLocalAliasAllow.md index 6bc0de3..09cb07c 100644 --- a/javascript/docs/CreateBucketRequestLocalAliasAllow.md +++ b/javascript/docs/CreateBucketRequestLocalAliasAllow.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.CreateBucketRequestLocalAliasAllow +# garage.CreateBucketRequestLocalAliasAllow ## Properties diff --git a/javascript/docs/GetNodes200Response.md b/javascript/docs/GetNodes200Response.md index 761f999..bcf6758 100644 --- a/javascript/docs/GetNodes200Response.md +++ b/javascript/docs/GetNodes200Response.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.GetNodes200Response +# garage.GetNodes200Response ## Properties diff --git a/javascript/docs/ImportKeyRequest.md b/javascript/docs/ImportKeyRequest.md index 2469e0e..3de7d4e 100644 --- a/javascript/docs/ImportKeyRequest.md +++ b/javascript/docs/ImportKeyRequest.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.ImportKeyRequest +# garage.ImportKeyRequest ## Properties diff --git a/javascript/docs/KeyApi.md b/javascript/docs/KeyApi.md index facf026..99cbcde 100644 --- a/javascript/docs/KeyApi.md +++ b/javascript/docs/KeyApi.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.KeyApi +# garage.KeyApi All URIs are relative to *http://localhost:3903/v0* @@ -25,14 +25,14 @@ Creates a new API access key. ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); -let addKeyRequest = new GarageAdministrationApiV0garageV080.AddKeyRequest(); // AddKeyRequest | \"You can set a friendly name for this key, send an empty string instead\" +let apiInstance = new garage.KeyApi(); +let addKeyRequest = new garage.AddKeyRequest(); // AddKeyRequest | \"You can set a friendly name for this key, send an empty string instead\" apiInstance.addKey(addKeyRequest, (error, data, response) => { if (error) { console.error(error); @@ -74,13 +74,13 @@ Delete a key from the cluster. Its access will be removed from all the buckets. ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); +let apiInstance = new garage.KeyApi(); let accessKey = GK31c2f218a2e44f485b94239e; // String | The exact API access key generated by Garage apiInstance.deleteKey(accessKey, (error, data, response) => { if (error) { @@ -123,13 +123,13 @@ Return information about a specific key and return its information ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); +let apiInstance = new garage.KeyApi(); let accessKey = GK31c2f218a2e44f485b94239e; // String | The exact API access key generated by Garage apiInstance.getKey(accessKey, (error, data, response) => { if (error) { @@ -172,14 +172,14 @@ Imports an existing API key. This feature must only be used for migrations and b ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); -let importKeyRequest = new GarageAdministrationApiV0garageV080.ImportKeyRequest(); // ImportKeyRequest | Information on the key to import +let apiInstance = new garage.KeyApi(); +let importKeyRequest = new garage.ImportKeyRequest(); // ImportKeyRequest | Information on the key to import apiInstance.importKey(importKeyRequest, (error, data, response) => { if (error) { console.error(error); @@ -221,13 +221,13 @@ Returns all API access keys in the cluster. ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); +let apiInstance = new garage.KeyApi(); apiInstance.listKeys((error, data, response) => { if (error) { console.error(error); @@ -266,13 +266,13 @@ Find the first key matching the given pattern based on its identifier aor friend ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); +let apiInstance = new garage.KeyApi(); let pattern = test-k; // String | A pattern (beginning or full string) corresponding to a key identifier or friendly name apiInstance.searchKey(pattern, (error, data, response) => { if (error) { @@ -315,15 +315,15 @@ Updates information about the specified API access key. ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); +let apiInstance = new garage.KeyApi(); let accessKey = GK31c2f218a2e44f485b94239e; // String | The exact API access key generated by Garage -let updateKeyRequest = new GarageAdministrationApiV0garageV080.UpdateKeyRequest(); // UpdateKeyRequest | For a given key, provide a first set with the permissions to grant, and a second set with the permissions to remove +let updateKeyRequest = new garage.UpdateKeyRequest(); // UpdateKeyRequest | For a given key, provide a first set with the permissions to grant, and a second set with the permissions to remove apiInstance.updateKey(accessKey, updateKeyRequest, (error, data, response) => { if (error) { console.error(error); diff --git a/javascript/docs/KeyInfo.md b/javascript/docs/KeyInfo.md index b93a4d6..fff00b1 100644 --- a/javascript/docs/KeyInfo.md +++ b/javascript/docs/KeyInfo.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.KeyInfo +# garage.KeyInfo ## Properties diff --git a/javascript/docs/KeyInfoBucketsInner.md b/javascript/docs/KeyInfoBucketsInner.md index 3ab76c3..4e43408 100644 --- a/javascript/docs/KeyInfoBucketsInner.md +++ b/javascript/docs/KeyInfoBucketsInner.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.KeyInfoBucketsInner +# garage.KeyInfoBucketsInner ## Properties diff --git a/javascript/docs/KeyInfoBucketsInnerPermissions.md b/javascript/docs/KeyInfoBucketsInnerPermissions.md index 34d2f7a..9e6b3d7 100644 --- a/javascript/docs/KeyInfoBucketsInnerPermissions.md +++ b/javascript/docs/KeyInfoBucketsInnerPermissions.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.KeyInfoBucketsInnerPermissions +# garage.KeyInfoBucketsInnerPermissions ## Properties diff --git a/javascript/docs/KeyInfoPermissions.md b/javascript/docs/KeyInfoPermissions.md index 485ae1e..ccf75d1 100644 --- a/javascript/docs/KeyInfoPermissions.md +++ b/javascript/docs/KeyInfoPermissions.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.KeyInfoPermissions +# garage.KeyInfoPermissions ## Properties diff --git a/javascript/docs/LayoutApi.md b/javascript/docs/LayoutApi.md index f1c5dda..89d0d29 100644 --- a/javascript/docs/LayoutApi.md +++ b/javascript/docs/LayoutApi.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.LayoutApi +# garage.LayoutApi All URIs are relative to *http://localhost:3903/v0* @@ -22,14 +22,14 @@ Send modifications to the cluster layout. These modifications will be included i ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.LayoutApi(); -let requestBody = {key: new GarageAdministrationApiV0garageV080.NodeClusterInfo()}; // {String: NodeClusterInfo} | To add a new node to the layout or to change the configuration of an existing node, simply set the values you want. To remove a node, set it to `null` instead of passing a configuration object. Contrary to the CLI that may update only a subset of the fields capacity, zone and tags, when calling this API all of these values must be specified. +let apiInstance = new garage.LayoutApi(); +let requestBody = {key: new garage.NodeClusterInfo()}; // {String: NodeClusterInfo} | To add a new node to the layout or to change the configuration of an existing node, simply set the values you want. To remove a node, set it to `null` instead of passing a configuration object. Contrary to the CLI that may update only a subset of the fields capacity, zone and tags, when calling this API all of these values must be specified. apiInstance.addLayout(requestBody, (error, data, response) => { if (error) { console.error(error); @@ -71,14 +71,14 @@ Applies to the cluster the layout changes currently registered as staged layout ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.LayoutApi(); -let layoutVersion = new GarageAdministrationApiV0garageV080.LayoutVersion(); // LayoutVersion | Similarly to the CLI, the body must include the version of the new layout that will be created, which MUST be 1 + the value of the currently existing layout in the cluster. +let apiInstance = new garage.LayoutApi(); +let layoutVersion = new garage.LayoutVersion(); // LayoutVersion | Similarly to the CLI, the body must include the version of the new layout that will be created, which MUST be 1 + the value of the currently existing layout in the cluster. apiInstance.applyLayout(layoutVersion, (error, data, response) => { if (error) { console.error(error); @@ -120,13 +120,13 @@ Returns the cluster's current layout, including: - Currently configured cl ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.LayoutApi(); +let apiInstance = new garage.LayoutApi(); apiInstance.getLayout((error, data, response) => { if (error) { console.error(error); @@ -165,14 +165,14 @@ Clears all of the staged layout changes. ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.LayoutApi(); -let layoutVersion = new GarageAdministrationApiV0garageV080.LayoutVersion(); // LayoutVersion | Reverting the staged changes is done by incrementing the version number and clearing the contents of the staged change list. Similarly to the CLI, the body must include the incremented version number, which MUST be 1 + the value of the currently existing layout in the cluster. +let apiInstance = new garage.LayoutApi(); +let layoutVersion = new garage.LayoutVersion(); // LayoutVersion | Reverting the staged changes is done by incrementing the version number and clearing the contents of the staged change list. Similarly to the CLI, the body must include the incremented version number, which MUST be 1 + the value of the currently existing layout in the cluster. apiInstance.revertLayout(layoutVersion, (error, data, response) => { if (error) { console.error(error); diff --git a/javascript/docs/LayoutVersion.md b/javascript/docs/LayoutVersion.md index a7c8974..521aa5d 100644 --- a/javascript/docs/LayoutVersion.md +++ b/javascript/docs/LayoutVersion.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.LayoutVersion +# garage.LayoutVersion ## Properties diff --git a/javascript/docs/ListBuckets200ResponseInner.md b/javascript/docs/ListBuckets200ResponseInner.md index 220f034..a8369a9 100644 --- a/javascript/docs/ListBuckets200ResponseInner.md +++ b/javascript/docs/ListBuckets200ResponseInner.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.ListBuckets200ResponseInner +# garage.ListBuckets200ResponseInner ## Properties diff --git a/javascript/docs/ListBuckets200ResponseInnerLocalAliasesInner.md b/javascript/docs/ListBuckets200ResponseInnerLocalAliasesInner.md index cfcff66..9cd2ce9 100644 --- a/javascript/docs/ListBuckets200ResponseInnerLocalAliasesInner.md +++ b/javascript/docs/ListBuckets200ResponseInnerLocalAliasesInner.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.ListBuckets200ResponseInnerLocalAliasesInner +# garage.ListBuckets200ResponseInnerLocalAliasesInner ## Properties diff --git a/javascript/docs/ListKeys200ResponseInner.md b/javascript/docs/ListKeys200ResponseInner.md index ffc3471..5975ab9 100644 --- a/javascript/docs/ListKeys200ResponseInner.md +++ b/javascript/docs/ListKeys200ResponseInner.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.ListKeys200ResponseInner +# garage.ListKeys200ResponseInner ## Properties diff --git a/javascript/docs/NodeClusterInfo.md b/javascript/docs/NodeClusterInfo.md index 4a1af45..da13ef3 100644 --- a/javascript/docs/NodeClusterInfo.md +++ b/javascript/docs/NodeClusterInfo.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.NodeClusterInfo +# garage.NodeClusterInfo ## Properties diff --git a/javascript/docs/NodeNetworkInfo.md b/javascript/docs/NodeNetworkInfo.md index 6b76963..943734c 100644 --- a/javascript/docs/NodeNetworkInfo.md +++ b/javascript/docs/NodeNetworkInfo.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.NodeNetworkInfo +# garage.NodeNetworkInfo ## Properties diff --git a/javascript/docs/NodesApi.md b/javascript/docs/NodesApi.md index 707bb2b..8f91109 100644 --- a/javascript/docs/NodesApi.md +++ b/javascript/docs/NodesApi.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.NodesApi +# garage.NodesApi All URIs are relative to *http://localhost:3903/v0* @@ -20,13 +20,13 @@ Instructs this Garage node to connect to other Garage nodes at specified `& ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.NodesApi(); +let apiInstance = new garage.NodesApi(); let requestBody = ["null"]; // [String] | apiInstance.addNode(requestBody, (error, data, response) => { if (error) { @@ -69,13 +69,13 @@ Returns the cluster's current status, including: - ID of the node being que ### Example ```javascript -import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; -let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; +import garage from 'garage_administration_api_v0garage_v0_8_0'; +let defaultClient = garage.ApiClient.instance; // Configure Bearer access token for authorization: bearerAuth let bearerAuth = defaultClient.authentications['bearerAuth']; bearerAuth.accessToken = "YOUR ACCESS TOKEN" -let apiInstance = new GarageAdministrationApiV0garageV080.NodesApi(); +let apiInstance = new garage.NodesApi(); apiInstance.getNodes((error, data, response) => { if (error) { console.error(error); diff --git a/javascript/docs/UpdateBucketRequest.md b/javascript/docs/UpdateBucketRequest.md index ee904f1..1786d43 100644 --- a/javascript/docs/UpdateBucketRequest.md +++ b/javascript/docs/UpdateBucketRequest.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.UpdateBucketRequest +# garage.UpdateBucketRequest ## Properties diff --git a/javascript/docs/UpdateBucketRequestQuotas.md b/javascript/docs/UpdateBucketRequestQuotas.md index 0cf4015..b344626 100644 --- a/javascript/docs/UpdateBucketRequestQuotas.md +++ b/javascript/docs/UpdateBucketRequestQuotas.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.UpdateBucketRequestQuotas +# garage.UpdateBucketRequestQuotas ## Properties diff --git a/javascript/docs/UpdateBucketRequestWebsiteAccess.md b/javascript/docs/UpdateBucketRequestWebsiteAccess.md index 1bbdae8..c1fbb63 100644 --- a/javascript/docs/UpdateBucketRequestWebsiteAccess.md +++ b/javascript/docs/UpdateBucketRequestWebsiteAccess.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.UpdateBucketRequestWebsiteAccess +# garage.UpdateBucketRequestWebsiteAccess ## Properties diff --git a/javascript/docs/UpdateKeyRequest.md b/javascript/docs/UpdateKeyRequest.md index 62fa4d2..5fbbcd1 100644 --- a/javascript/docs/UpdateKeyRequest.md +++ b/javascript/docs/UpdateKeyRequest.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.UpdateKeyRequest +# garage.UpdateKeyRequest ## Properties diff --git a/javascript/docs/UpdateKeyRequestAllow.md b/javascript/docs/UpdateKeyRequestAllow.md index 9f594c6..2270595 100644 --- a/javascript/docs/UpdateKeyRequestAllow.md +++ b/javascript/docs/UpdateKeyRequestAllow.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.UpdateKeyRequestAllow +# garage.UpdateKeyRequestAllow ## Properties diff --git a/javascript/docs/UpdateKeyRequestDeny.md b/javascript/docs/UpdateKeyRequestDeny.md index 48f69d8..b8001fd 100644 --- a/javascript/docs/UpdateKeyRequestDeny.md +++ b/javascript/docs/UpdateKeyRequestDeny.md @@ -1,4 +1,4 @@ -# GarageAdministrationApiV0garageV080.UpdateKeyRequestDeny +# garage.UpdateKeyRequestDeny ## Properties diff --git a/javascript/src/index.js b/javascript/src/index.js index 2a05e43..76bb8d3 100644 --- a/javascript/src/index.js +++ b/javascript/src/index.js @@ -55,9 +55,9 @@ import NodesApi from './api/NodesApi'; *

* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: * 

-* var GarageAdministrationApiV0garageV080 = require('index'); // See note below*.
-* var xxxSvc = new GarageAdministrationApiV0garageV080.XxxApi(); // Allocate the API class we're going to use.
-* var yyyModel = new GarageAdministrationApiV0garageV080.Yyy(); // Construct a model instance.
+* var garage = require('index'); // See note below*.
+* var xxxSvc = new garage.XxxApi(); // Allocate the API class we're going to use.
+* var yyyModel = new garage.Yyy(); // Construct a model instance.
 * yyyModel.someProperty = 'someValue';
 * ...
 * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
@@ -69,8 +69,8 @@ import NodesApi from './api/NodesApi';
 * 

 * A non-AMD browser application (discouraged) might do something like this:
 * 
-* var xxxSvc = new GarageAdministrationApiV0garageV080.XxxApi(); // Allocate the API class we're going to use.
-* var yyy = new GarageAdministrationApiV0garageV080.Yyy(); // Construct a model instance.
+* var xxxSvc = new garage.XxxApi(); // Allocate the API class we're going to use.
+* var yyy = new garage.Yyy(); // Construct a model instance.
 * yyyModel.someProperty = 'someValue';
 * ...
 * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.