diff --git a/.manifest.json b/.manifest.json index 87b1555..6e5a05a 100644 --- a/.manifest.json +++ b/.manifest.json @@ -1,10 +1,10 @@ { - "liblabVersion": "2.3.1", - "date": "2024-09-11T23:34:32.865Z", + "liblabVersion": "2.4.0", + "date": "2024-09-17T04:36:04.572Z", "config": { "apiId": 1126, "sdkName": "salad-cloud-imds-sdk", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "liblabVersion": "2", "deliveryMethods": ["zip"], "languages": ["typescript"], @@ -25,7 +25,7 @@ "homepage": "https://github.com/saladtechnologies/salad-cloud-imds-sdk-dotnet", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" }, "go": { @@ -33,7 +33,7 @@ "githubRepoName": "salad-cloud-imds-sdk-go", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" }, "java": { @@ -57,7 +57,7 @@ "homepage": "https://github.com/saladtechnologies/salad-cloud-imds-sdk-java", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" }, "python": { @@ -100,7 +100,7 @@ "githubRepoName": "salad-cloud-imds-sdk-python", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" }, "typescript": { @@ -123,7 +123,7 @@ "homepage": "https://github.com/saladtechnologies/salad-cloud-imds-sdk-javascript", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" } }, @@ -155,7 +155,7 @@ }, "multiTenant": true, "hooksLocation": { - "bucketKey": "7096/hooks.zip", + "bucketKey": "7207/hooks.zip", "bucketName": "prod-liblab-api-stack-hooks" }, "includeWatermark": false, diff --git a/README.md b/README.md index ccfbc30..5fd88f0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# SaladCloudImdsSdk TypeScript SDK 0.9.0-alpha.2 +# SaladCloudImdsSdk TypeScript SDK 0.9.0-alpha.3 Welcome to the SaladCloudImdsSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudImdsSdk SDK in your project. ## Versions - API version: `0.9.0-alpha.1` -- SDK version: `0.9.0-alpha.2` +- SDK version: `0.9.0-alpha.3` ## About the API diff --git a/documentation/models/ContainerStatus.md b/documentation/models/ContainerStatus.md index 44c3ee6..4cdf0f8 100644 --- a/documentation/models/ContainerStatus.md +++ b/documentation/models/ContainerStatus.md @@ -4,7 +4,7 @@ Represents the health statuses of the running container. **Properties** -| Name | Type | Required | Description | -| :------ | :-------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ready | `boolean` | ✅ | `true` if the running container is ready. If a readiness probe is defined, this returns the latest result of the probe. If a readiness probe is not defined but a startup probe is defined, this returns the same value as the `started` property. If neither a readiness probe nor a startup probe are defined, returns `true`. | -| started | `boolean` | ✅ | `true` if the running container is started. If a startup probe is defined, this returns the latest result of the probe. If a startup probe is not defined, returns `true`. | +| Name | Type | Required | Description | +| :------ | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ready | boolean | ✅ | `true` if the running container is ready. If a readiness probe is defined, this returns the latest result of the probe. If a readiness probe is not defined but a startup probe is defined, this returns the same value as the `started` property. If neither a readiness probe nor a startup probe are defined, returns `true`. | +| started | boolean | ✅ | `true` if the running container is started. If a startup probe is defined, this returns the latest result of the probe. If a startup probe is not defined, returns `true`. | diff --git a/documentation/models/ContainerToken.md b/documentation/models/ContainerToken.md index 5341cdf..2f9c826 100644 --- a/documentation/models/ContainerToken.md +++ b/documentation/models/ContainerToken.md @@ -4,6 +4,6 @@ Represents the identity token of the running container. **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| jwt | `string` | ✅ | The JSON Web Token (JWT) that may be used to identify the running container. The JWT may be verified using the JSON Web Key Set (JWKS) available at https://matrix-rest-api.salad.com/.well-known/stash-jwks.json. | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| jwt | string | ✅ | The JSON Web Token (JWT) that may be used to identify the running container. The JWT may be verified using the JSON Web Key Set (JWKS) available at https://matrix-rest-api.salad.com/.well-known/stash-jwks.json. | diff --git a/documentation/models/ReallocateContainer.md b/documentation/models/ReallocateContainer.md index ab192ba..00c9ce4 100644 --- a/documentation/models/ReallocateContainer.md +++ b/documentation/models/ReallocateContainer.md @@ -4,6 +4,6 @@ Represents a request to reallocate a container. **Properties** -| Name | Type | Required | Description | -| :----- | :------- | :------- | :---------------------------------------------------------------------------------------------------------------------------- | -| reason | `string` | ✅ | The reason for reallocating the container. This value is reported to SaladCloud support for quality assurance of Salad Nodes. | +| Name | Type | Required | Description | +| :----- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------- | +| reason | string | ✅ | The reason for reallocating the container. This value is reported to SaladCloud support for quality assurance of Salad Nodes. | diff --git a/documentation/services/MetadataService.md b/documentation/services/MetadataService.md index 435eae6..5a02074 100644 --- a/documentation/services/MetadataService.md +++ b/documentation/services/MetadataService.md @@ -17,9 +17,9 @@ Reallocates the running container to another Salad Node **Parameters** -| Name | Type | Required | Description | -| :--- | :-------------------------------------------------------- | :------- | :---------------- | -| body | `[ReallocateContainer](../models/ReallocateContainer.md)` | ✅ | The request body. | +| Name | Type | Required | Description | +| :--- | :------------------------------------------------------ | :------- | :---------------- | +| body | [ReallocateContainer](../models/ReallocateContainer.md) | ✅ | The request body. | **Example Usage Code Snippet** diff --git a/examples/package.json b/examples/package.json index 4396009..17b1794 100644 --- a/examples/package.json +++ b/examples/package.json @@ -1,6 +1,6 @@ { "name": "salad-cloud-imds-sdk", - "version": "0.9.0-alpha.2", + "version": "0.9.0-alpha.3", "private": true, "dependencies": { "@saladtechnologies-oss/salad-cloud-imds-sdk": "file:../", diff --git a/package-lock.json b/package-lock.json index b780db6..cfa6252 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@saladtechnologies-oss/salad-cloud-imds-sdk", - "version": "0.9.0-alpha.2", + "version": "0.9.0-alpha.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@saladtechnologies-oss/salad-cloud-imds-sdk", - "version": "0.9.0-alpha.2", + "version": "0.9.0-alpha.3", "license": "MIT", "dependencies": { "zod": "3.22.0" diff --git a/package.json b/package.json index e0c0941..491b28f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@saladtechnologies-oss/salad-cloud-imds-sdk", - "version": "0.9.0-alpha.2", + "version": "0.9.0-alpha.3", "description": "The SaladCloud Instance Metadata Service (IMDS). Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details.", "source": "./src/index.ts", "main": "./dist/index.js", diff --git a/src/http/client.ts b/src/http/client.ts index 0bd0221..f9f00f8 100644 --- a/src/http/client.ts +++ b/src/http/client.ts @@ -31,7 +31,7 @@ export class HttpClient { const response = await this.call(request as any); if (!response.data) { - throw new Error('now response data to paginate through'); + throw new Error('no response data to paginate through'); } return { diff --git a/src/http/index.ts b/src/http/index.ts index 82bf7c7..236a3cf 100644 --- a/src/http/index.ts +++ b/src/http/index.ts @@ -7,3 +7,4 @@ export type { HttpMethod, HttpResponse, } from './types.ts'; +export type { HttpError } from './error.ts';