garage-sdk/garage-admin-sdk-generator
5
0
Fork 0
Code Issues Pull requests Projects Releases 1 Wiki Activity

change module name

Browse source
This commit is contained in:
Quentin 2022-11-12 23:50:53 +01:00
parent 2b7c845342
commit 8fff4c6068
Signed by: quentin
GPG key ID: E9602264D639FF68
38 changed files with 185 additions and 219 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
build.gradle
View file

@ -34,6 +34,7 @@ task buildJavascriptClient(type: org.openapitools.generator.gradle.plugin.tasks.
outputDir = "$rootDir/javascript" outputDir = "$rootDir/javascript"
configOptions = [ configOptions = [
packageName: "garage", packageName: "garage",
moduleName: "garage",
packageVersion: "0.8.0", packageVersion: "0.8.0",
] ]
} }

35
javascript/.openapi-generator/FILES
View file

@ -1,6 +1,5 @@
.babelrc .babelrc
.gitignore .gitignore
.openapi-generator-ignore
.travis.yml .travis.yml
README.md README.md
docs/AddKeyRequest.md docs/AddKeyRequest.md
@ -76,37 +75,3 @@ src/model/UpdateBucketRequestWebsiteAccess.js
src/model/UpdateKeyRequest.js src/model/UpdateKeyRequest.js
src/model/UpdateKeyRequestAllow.js src/model/UpdateKeyRequestAllow.js
src/model/UpdateKeyRequestDeny.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

120
javascript/README.md
View file

@ -1,6 +1,6 @@
# garage_administration_api_v0garage_v0_8_0 # 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. 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!* *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: Please follow the [installation](#installation) instruction and execute the following JS code:
```javascript ```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 // Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth']; var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
var api = new GarageAdministrationApiV0garageV080.BucketApi() var api = new garage.BucketApi()
var allowBucketKeyRequest = new GarageAdministrationApiV0garageV080.AllowBucketKeyRequest(); // {AllowBucketKeyRequest} Aliases to put on the new bucket var allowBucketKeyRequest = new garage.AllowBucketKeyRequest(); // {AllowBucketKeyRequest} Aliases to put on the new bucket
var callback = function(error, data, response) { var callback = function(error, data, response) {
if (error) { if (error) {
console.error(error); console.error(error);
@ -127,65 +127,65 @@ All URIs are relative to *http://localhost:3903/v0*
Class | Method | HTTP request | Description Class | Method | HTTP request | Description
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
*GarageAdministrationApiV0garageV080.BucketApi* | [**allowBucketKey**](docs/BucketApi.md#allowBucketKey) | **POST** /bucket/allow | Allow key *garage.BucketApi* | [**allowBucketKey**](docs/BucketApi.md#allowBucketKey) | **POST** /bucket/allow | Allow key
*GarageAdministrationApiV0garageV080.BucketApi* | [**createBucket**](docs/BucketApi.md#createBucket) | **POST** /bucket | Create a bucket *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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 *garage.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.NodesApi* | [**getNodes**](docs/NodesApi.md#getNodes) | **GET** /status | Status of this node and other nodes in the cluster
## Documentation for Models ## Documentation for Models
- [GarageAdministrationApiV0garageV080.AddKeyRequest](docs/AddKeyRequest.md) - [garage.AddKeyRequest](docs/AddKeyRequest.md)
- [GarageAdministrationApiV0garageV080.AddNode200ResponseInner](docs/AddNode200ResponseInner.md) - [garage.AddNode200ResponseInner](docs/AddNode200ResponseInner.md)
- [GarageAdministrationApiV0garageV080.AllowBucketKeyRequest](docs/AllowBucketKeyRequest.md) - [garage.AllowBucketKeyRequest](docs/AllowBucketKeyRequest.md)
- [GarageAdministrationApiV0garageV080.AllowBucketKeyRequestPermissions](docs/AllowBucketKeyRequestPermissions.md) - [garage.AllowBucketKeyRequestPermissions](docs/AllowBucketKeyRequestPermissions.md)
- [GarageAdministrationApiV0garageV080.BucketInfo](docs/BucketInfo.md) - [garage.BucketInfo](docs/BucketInfo.md)
- [GarageAdministrationApiV0garageV080.BucketInfoQuotas](docs/BucketInfoQuotas.md) - [garage.BucketInfoQuotas](docs/BucketInfoQuotas.md)
- [GarageAdministrationApiV0garageV080.BucketInfoWebsiteConfig](docs/BucketInfoWebsiteConfig.md) - [garage.BucketInfoWebsiteConfig](docs/BucketInfoWebsiteConfig.md)
- [GarageAdministrationApiV0garageV080.BucketKeyInfo](docs/BucketKeyInfo.md) - [garage.BucketKeyInfo](docs/BucketKeyInfo.md)
- [GarageAdministrationApiV0garageV080.ClusterLayout](docs/ClusterLayout.md) - [garage.ClusterLayout](docs/ClusterLayout.md)
- [GarageAdministrationApiV0garageV080.CreateBucketRequest](docs/CreateBucketRequest.md) - [garage.CreateBucketRequest](docs/CreateBucketRequest.md)
- [GarageAdministrationApiV0garageV080.CreateBucketRequestLocalAlias](docs/CreateBucketRequestLocalAlias.md) - [garage.CreateBucketRequestLocalAlias](docs/CreateBucketRequestLocalAlias.md)
- [GarageAdministrationApiV0garageV080.CreateBucketRequestLocalAliasAllow](docs/CreateBucketRequestLocalAliasAllow.md) - [garage.CreateBucketRequestLocalAliasAllow](docs/CreateBucketRequestLocalAliasAllow.md)
- [GarageAdministrationApiV0garageV080.GetNodes200Response](docs/GetNodes200Response.md) - [garage.GetNodes200Response](docs/GetNodes200Response.md)
- [GarageAdministrationApiV0garageV080.ImportKeyRequest](docs/ImportKeyRequest.md) - [garage.ImportKeyRequest](docs/ImportKeyRequest.md)
- [GarageAdministrationApiV0garageV080.KeyInfo](docs/KeyInfo.md) - [garage.KeyInfo](docs/KeyInfo.md)
- [GarageAdministrationApiV0garageV080.KeyInfoBucketsInner](docs/KeyInfoBucketsInner.md) - [garage.KeyInfoBucketsInner](docs/KeyInfoBucketsInner.md)
- [GarageAdministrationApiV0garageV080.KeyInfoBucketsInnerPermissions](docs/KeyInfoBucketsInnerPermissions.md) - [garage.KeyInfoBucketsInnerPermissions](docs/KeyInfoBucketsInnerPermissions.md)
- [GarageAdministrationApiV0garageV080.KeyInfoPermissions](docs/KeyInfoPermissions.md) - [garage.KeyInfoPermissions](docs/KeyInfoPermissions.md)
- [GarageAdministrationApiV0garageV080.LayoutVersion](docs/LayoutVersion.md) - [garage.LayoutVersion](docs/LayoutVersion.md)
- [GarageAdministrationApiV0garageV080.ListBuckets200ResponseInner](docs/ListBuckets200ResponseInner.md) - [garage.ListBuckets200ResponseInner](docs/ListBuckets200ResponseInner.md)
- [GarageAdministrationApiV0garageV080.ListBuckets200ResponseInnerLocalAliasesInner](docs/ListBuckets200ResponseInnerLocalAliasesInner.md) - [garage.ListBuckets200ResponseInnerLocalAliasesInner](docs/ListBuckets200ResponseInnerLocalAliasesInner.md)
- [GarageAdministrationApiV0garageV080.ListKeys200ResponseInner](docs/ListKeys200ResponseInner.md) - [garage.ListKeys200ResponseInner](docs/ListKeys200ResponseInner.md)
- [GarageAdministrationApiV0garageV080.NodeClusterInfo](docs/NodeClusterInfo.md) - [garage.NodeClusterInfo](docs/NodeClusterInfo.md)
- [GarageAdministrationApiV0garageV080.NodeNetworkInfo](docs/NodeNetworkInfo.md) - [garage.NodeNetworkInfo](docs/NodeNetworkInfo.md)
- [GarageAdministrationApiV0garageV080.UpdateBucketRequest](docs/UpdateBucketRequest.md) - [garage.UpdateBucketRequest](docs/UpdateBucketRequest.md)
- [GarageAdministrationApiV0garageV080.UpdateBucketRequestQuotas](docs/UpdateBucketRequestQuotas.md) - [garage.UpdateBucketRequestQuotas](docs/UpdateBucketRequestQuotas.md)
- [GarageAdministrationApiV0garageV080.UpdateBucketRequestWebsiteAccess](docs/UpdateBucketRequestWebsiteAccess.md) - [garage.UpdateBucketRequestWebsiteAccess](docs/UpdateBucketRequestWebsiteAccess.md)
- [GarageAdministrationApiV0garageV080.UpdateKeyRequest](docs/UpdateKeyRequest.md) - [garage.UpdateKeyRequest](docs/UpdateKeyRequest.md)
- [GarageAdministrationApiV0garageV080.UpdateKeyRequestAllow](docs/UpdateKeyRequestAllow.md) - [garage.UpdateKeyRequestAllow](docs/UpdateKeyRequestAllow.md)
- [GarageAdministrationApiV0garageV080.UpdateKeyRequestDeny](docs/UpdateKeyRequestDeny.md) - [garage.UpdateKeyRequestDeny](docs/UpdateKeyRequestDeny.md)
## Documentation for Authorization ## Documentation for Authorization

2
javascript/docs/AddKeyRequest.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.AddKeyRequest # garage.AddKeyRequest
## Properties ## Properties

2
javascript/docs/AddNode200ResponseInner.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.AddNode200ResponseInner # garage.AddNode200ResponseInner
## Properties ## Properties

2
javascript/docs/AllowBucketKeyRequest.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.AllowBucketKeyRequest # garage.AllowBucketKeyRequest
## Properties ## Properties

2
javascript/docs/AllowBucketKeyRequestPermissions.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.AllowBucketKeyRequestPermissions # garage.AllowBucketKeyRequestPermissions
## Properties ## Properties

82
javascript/docs/BucketApi.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.BucketApi # garage.BucketApi
All URIs are relative to *http://localhost:3903/v0* All URIs are relative to *http://localhost:3903/v0*
@ -30,14 +30,14 @@ Allow key
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); let apiInstance = new garage.BucketApi();
let allowBucketKeyRequest = new GarageAdministrationApiV0garageV080.AllowBucketKeyRequest(); // AllowBucketKeyRequest | Aliases to put on the new bucket let allowBucketKeyRequest = new garage.AllowBucketKeyRequest(); // AllowBucketKeyRequest | Aliases to put on the new bucket
apiInstance.allowBucketKey(allowBucketKeyRequest, (error, data, response) => { apiInstance.allowBucketKey(allowBucketKeyRequest, (error, data, response) => {
if (error) { if (error) {
console.error(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 ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); let apiInstance = new garage.BucketApi();
let createBucketRequest = new GarageAdministrationApiV0garageV080.CreateBucketRequest(); // CreateBucketRequest | Aliases to put on the new bucket let createBucketRequest = new garage.CreateBucketRequest(); // CreateBucketRequest | Aliases to put on the new bucket
apiInstance.createBucket(createBucketRequest, (error, data, response) => { apiInstance.createBucket(createBucketRequest, (error, data, response) => {
if (error) { if (error) {
console.error(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 ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" 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 bucketId = b4018dc61b27ccb5c64ec1b24f53454bbbd180697c758c4d47a22a8921864a87; // String | The exact bucket identifier, a 32 bytes hexadecimal string
apiInstance.deleteBucket(bucketId, (error, data, response) => { apiInstance.deleteBucket(bucketId, (error, data, response) => {
if (error) { if (error) {
@ -177,13 +177,13 @@ Delete a global alias from the target bucket
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); let apiInstance = new garage.BucketApi();
let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String | let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String |
let alias = my_documents; // String | let alias = my_documents; // String |
apiInstance.deleteBucketGlobalAlias(id, alias, (error, data, response) => { apiInstance.deleteBucketGlobalAlias(id, alias, (error, data, response) => {
@ -228,13 +228,13 @@ Delete a local alias, bound to specified account, from the target bucket
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); let apiInstance = new garage.BucketApi();
let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String | let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String |
let accessKeyId = GK31c2f218a2e44f485b94239e; // String | let accessKeyId = GK31c2f218a2e44f485b94239e; // String |
let alias = my_documents; // String | let alias = my_documents; // String |
@ -281,14 +281,14 @@ Deny key
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); let apiInstance = new garage.BucketApi();
let allowBucketKeyRequest = new GarageAdministrationApiV0garageV080.AllowBucketKeyRequest(); // AllowBucketKeyRequest | Aliases to put on the new bucket let allowBucketKeyRequest = new garage.AllowBucketKeyRequest(); // AllowBucketKeyRequest | Aliases to put on the new bucket
apiInstance.denyBucketKey(allowBucketKeyRequest, (error, data, response) => { apiInstance.denyBucketKey(allowBucketKeyRequest, (error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);
@ -330,13 +330,13 @@ Find a bucket by its global alias
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" 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 let alias = my_documents; // String | The exact global alias of one of the existing buckets
apiInstance.findBucketInfo(alias, (error, data, response) => { apiInstance.findBucketInfo(alias, (error, data, response) => {
if (error) { if (error) {
@ -379,13 +379,13 @@ Given a bucket identifier, get its information. It includes its aliases, its web
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" 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 bucketId = b4018dc61b27ccb5c64ec1b24f53454bbbd180697c758c4d47a22a8921864a87; // String | The exact bucket identifier, a 32 bytes hexadecimal string
apiInstance.getBucketInfo(bucketId, (error, data, response) => { apiInstance.getBucketInfo(bucketId, (error, data, response) => {
if (error) { if (error) {
@ -428,13 +428,13 @@ List all the buckets on the cluster with their UUID and their global and local a
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); let apiInstance = new garage.BucketApi();
apiInstance.listBuckets((error, data, response) => { apiInstance.listBuckets((error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);
@ -473,13 +473,13 @@ Add a global alias to the target bucket
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); let apiInstance = new garage.BucketApi();
let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String | let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String |
let alias = my_documents; // String | let alias = my_documents; // String |
apiInstance.putBucketGlobalAlias(id, alias, (error, data, response) => { apiInstance.putBucketGlobalAlias(id, alias, (error, data, response) => {
@ -524,13 +524,13 @@ Add a local alias, bound to specified account, to the target bucket
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.BucketApi(); let apiInstance = new garage.BucketApi();
let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String | let id = e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b; // String |
let accessKeyId = GK31c2f218a2e44f485b94239e; // String | let accessKeyId = GK31c2f218a2e44f485b94239e; // String |
let alias = my_documents; // String | let alias = my_documents; // String |
@ -577,15 +577,15 @@ All fields (`websiteAccess` and `quotas`) are optionnal. If
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" 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 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) => { apiInstance.updateBucket(bucketId, updateBucketRequest, (error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);

2
javascript/docs/BucketInfo.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.BucketInfo # garage.BucketInfo
## Properties ## Properties

2
javascript/docs/BucketInfoQuotas.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.BucketInfoQuotas # garage.BucketInfoQuotas
## Properties ## Properties

2
javascript/docs/BucketInfoWebsiteConfig.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.BucketInfoWebsiteConfig # garage.BucketInfoWebsiteConfig
## Properties ## Properties

2
javascript/docs/BucketKeyInfo.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.BucketKeyInfo # garage.BucketKeyInfo
## Properties ## Properties

2
javascript/docs/ClusterLayout.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.ClusterLayout # garage.ClusterLayout
## Properties ## Properties

2
javascript/docs/CreateBucketRequest.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.CreateBucketRequest # garage.CreateBucketRequest
## Properties ## Properties

2
javascript/docs/CreateBucketRequestLocalAlias.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.CreateBucketRequestLocalAlias # garage.CreateBucketRequestLocalAlias
## Properties ## Properties

2
javascript/docs/CreateBucketRequestLocalAliasAllow.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.CreateBucketRequestLocalAliasAllow # garage.CreateBucketRequestLocalAliasAllow
## Properties ## Properties

2
javascript/docs/GetNodes200Response.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.GetNodes200Response # garage.GetNodes200Response
## Properties ## Properties

2
javascript/docs/ImportKeyRequest.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.ImportKeyRequest # garage.ImportKeyRequest
## Properties ## Properties

50
javascript/docs/KeyApi.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.KeyApi # garage.KeyApi
All URIs are relative to *http://localhost:3903/v0* All URIs are relative to *http://localhost:3903/v0*
@ -25,14 +25,14 @@ Creates a new API access key.
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); let apiInstance = new garage.KeyApi();
let addKeyRequest = new GarageAdministrationApiV0garageV080.AddKeyRequest(); // AddKeyRequest | \"You can set a friendly name for this key, send an empty string instead\" 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) => { apiInstance.addKey(addKeyRequest, (error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);
@ -74,13 +74,13 @@ Delete a key from the cluster. Its access will be removed from all the buckets.
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" 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 accessKey = GK31c2f218a2e44f485b94239e; // String | The exact API access key generated by Garage
apiInstance.deleteKey(accessKey, (error, data, response) => { apiInstance.deleteKey(accessKey, (error, data, response) => {
if (error) { if (error) {
@ -123,13 +123,13 @@ Return information about a specific key and return its information
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" 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 accessKey = GK31c2f218a2e44f485b94239e; // String | The exact API access key generated by Garage
apiInstance.getKey(accessKey, (error, data, response) => { apiInstance.getKey(accessKey, (error, data, response) => {
if (error) { if (error) {
@ -172,14 +172,14 @@ Imports an existing API key. This feature must only be used for migrations and b
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); let apiInstance = new garage.KeyApi();
let importKeyRequest = new GarageAdministrationApiV0garageV080.ImportKeyRequest(); // ImportKeyRequest | Information on the key to import let importKeyRequest = new garage.ImportKeyRequest(); // ImportKeyRequest | Information on the key to import
apiInstance.importKey(importKeyRequest, (error, data, response) => { apiInstance.importKey(importKeyRequest, (error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);
@ -221,13 +221,13 @@ Returns all API access keys in the cluster.
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.KeyApi(); let apiInstance = new garage.KeyApi();
apiInstance.listKeys((error, data, response) => { apiInstance.listKeys((error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);
@ -266,13 +266,13 @@ Find the first key matching the given pattern based on its identifier aor friend
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" 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 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) => { apiInstance.searchKey(pattern, (error, data, response) => {
if (error) { if (error) {
@ -315,15 +315,15 @@ Updates information about the specified API access key.
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" 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 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) => { apiInstance.updateKey(accessKey, updateKeyRequest, (error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);

2
javascript/docs/KeyInfo.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.KeyInfo # garage.KeyInfo
## Properties ## Properties

2
javascript/docs/KeyInfoBucketsInner.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.KeyInfoBucketsInner # garage.KeyInfoBucketsInner
## Properties ## Properties

2
javascript/docs/KeyInfoBucketsInnerPermissions.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.KeyInfoBucketsInnerPermissions # garage.KeyInfoBucketsInnerPermissions
## Properties ## Properties

2
javascript/docs/KeyInfoPermissions.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.KeyInfoPermissions # garage.KeyInfoPermissions
## Properties ## Properties

32
javascript/docs/LayoutApi.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.LayoutApi # garage.LayoutApi
All URIs are relative to *http://localhost:3903/v0* 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 ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.LayoutApi(); let apiInstance = new garage.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 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) => { apiInstance.addLayout(requestBody, (error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);
@ -71,14 +71,14 @@ Applies to the cluster the layout changes currently registered as staged layout
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.LayoutApi(); let apiInstance = new garage.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 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) => { apiInstance.applyLayout(layoutVersion, (error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);
@ -120,13 +120,13 @@ Returns the cluster's current layout, including: - Currently configured cl
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.LayoutApi(); let apiInstance = new garage.LayoutApi();
apiInstance.getLayout((error, data, response) => { apiInstance.getLayout((error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);
@ -165,14 +165,14 @@ Clears all of the staged layout changes.
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.LayoutApi(); let apiInstance = new garage.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 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) => { apiInstance.revertLayout(layoutVersion, (error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);

2
javascript/docs/LayoutVersion.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.LayoutVersion # garage.LayoutVersion
## Properties ## Properties

2
javascript/docs/ListBuckets200ResponseInner.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.ListBuckets200ResponseInner # garage.ListBuckets200ResponseInner
## Properties ## Properties

2
javascript/docs/ListBuckets200ResponseInnerLocalAliasesInner.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.ListBuckets200ResponseInnerLocalAliasesInner # garage.ListBuckets200ResponseInnerLocalAliasesInner
## Properties ## Properties

2
javascript/docs/ListKeys200ResponseInner.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.ListKeys200ResponseInner # garage.ListKeys200ResponseInner
## Properties ## Properties

2
javascript/docs/NodeClusterInfo.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.NodeClusterInfo # garage.NodeClusterInfo
## Properties ## Properties

2
javascript/docs/NodeNetworkInfo.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.NodeNetworkInfo # garage.NodeNetworkInfo
## Properties ## Properties

14
javascript/docs/NodesApi.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.NodesApi # garage.NodesApi
All URIs are relative to *http://localhost:3903/v0* 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 ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.NodesApi(); let apiInstance = new garage.NodesApi();
let requestBody = ["null"]; // [String] | let requestBody = ["null"]; // [String] |
apiInstance.addNode(requestBody, (error, data, response) => { apiInstance.addNode(requestBody, (error, data, response) => {
if (error) { if (error) {
@ -69,13 +69,13 @@ Returns the cluster's current status, including: - ID of the node being que
### Example ### Example
```javascript ```javascript
import GarageAdministrationApiV0garageV080 from 'garage_administration_api_v0garage_v0_8_0'; import garage from 'garage_administration_api_v0garage_v0_8_0';
let defaultClient = GarageAdministrationApiV0garageV080.ApiClient.instance; let defaultClient = garage.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth // Configure Bearer access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth']; let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN" bearerAuth.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new GarageAdministrationApiV0garageV080.NodesApi(); let apiInstance = new garage.NodesApi();
apiInstance.getNodes((error, data, response) => { apiInstance.getNodes((error, data, response) => {
if (error) { if (error) {
console.error(error); console.error(error);

2
javascript/docs/UpdateBucketRequest.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.UpdateBucketRequest # garage.UpdateBucketRequest
## Properties ## Properties

2
javascript/docs/UpdateBucketRequestQuotas.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.UpdateBucketRequestQuotas # garage.UpdateBucketRequestQuotas
## Properties ## Properties

2
javascript/docs/UpdateBucketRequestWebsiteAccess.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.UpdateBucketRequestWebsiteAccess # garage.UpdateBucketRequestWebsiteAccess
## Properties ## Properties

2
javascript/docs/UpdateKeyRequest.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.UpdateKeyRequest # garage.UpdateKeyRequest
## Properties ## Properties

2
javascript/docs/UpdateKeyRequestAllow.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.UpdateKeyRequestAllow # garage.UpdateKeyRequestAllow
## Properties ## Properties

2
javascript/docs/UpdateKeyRequestDeny.md
View file

@ -1,4 +1,4 @@
# GarageAdministrationApiV0garageV080.UpdateKeyRequestDeny # garage.UpdateKeyRequestDeny
## Properties ## Properties

10
javascript/src/index.js
View file

@ -55,9 +55,9 @@ import NodesApi from './api/NodesApi';
* <p> * <p>
* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: * An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:
* <pre> * <pre>
* var GarageAdministrationApiV0garageV080 = require('index'); // See note below*. * var garage = require('index'); // See note below*.
* var xxxSvc = new GarageAdministrationApiV0garageV080.XxxApi(); // Allocate the API class we're going to use. * var xxxSvc = new garage.XxxApi(); // Allocate the API class we're going to use.
* var yyyModel = new GarageAdministrationApiV0garageV080.Yyy(); // Construct a model instance. * var yyyModel = new garage.Yyy(); // Construct a model instance.
* yyyModel.someProperty = 'someValue'; * yyyModel.someProperty = 'someValue';
* ... * ...
* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service. * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
@ -69,8 +69,8 @@ import NodesApi from './api/NodesApi';
* <p> * <p>
* A non-AMD browser application (discouraged) might do something like this: * A non-AMD browser application (discouraged) might do something like this:
* <pre> * <pre>
* var xxxSvc = new GarageAdministrationApiV0garageV080.XxxApi(); // Allocate the API class we're going to use. * var xxxSvc = new garage.XxxApi(); // Allocate the API class we're going to use.
* var yyy = new GarageAdministrationApiV0garageV080.Yyy(); // Construct a model instance. * var yyy = new garage.Yyy(); // Construct a model instance.
* yyyModel.someProperty = 'someValue'; * yyyModel.someProperty = 'someValue';
* ... * ...
* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service. * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.