From 5b9205f45a7629407b6deb4f55daedc67fa78fee Mon Sep 17 00:00:00 2001 From: SaladTechnologies <415806+seniorquico@users.noreply.github.com> Date: Wed, 11 Sep 2024 23:34:59 +0000 Subject: [PATCH] liblab SDK update for version v0.9.0-alpha.2 --- .manifest.json | 18 +++++++------- PyPI_README.md | 26 ++++++++++---------- README.md | 4 +-- documentation/models/ContainerStatus.md | 8 +++--- documentation/models/ContainerToken.md | 6 ++--- documentation/models/ReallocateContainer.md | 6 ++--- documentation/services/MetadataService.md | 8 +++--- documentation/snippets/v1-reallocate-post.md | 2 +- examples/install.cmd | 2 +- examples/install.sh | 2 +- install.cmd | 2 +- install.sh | 2 +- pyproject.toml | 2 +- 13 files changed, 44 insertions(+), 44 deletions(-) diff --git a/.manifest.json b/.manifest.json index b935931..e9ff6bb 100644 --- a/.manifest.json +++ b/.manifest.json @@ -1,10 +1,10 @@ { - "liblabVersion": "2.1.31", - "date": "2024-09-06T14:42:23.145Z", + "liblabVersion": "2.3.1", + "date": "2024-09-11T23:34:37.044Z", "config": { "apiId": 1126, "sdkName": "salad-cloud-imds-sdk", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "liblabVersion": "2", "deliveryMethods": ["zip"], "languages": ["python"], @@ -25,7 +25,7 @@ "homepage": "https://github.com/saladtechnologies/salad-cloud-imds-sdk-dotnet", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "targetBranch": "main" }, "go": { @@ -33,7 +33,7 @@ "githubRepoName": "salad-cloud-imds-sdk-go", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "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.1", + "sdkVersion": "0.9.0-alpha.2", "targetBranch": "main" }, "python": { @@ -100,7 +100,7 @@ "githubRepoName": "salad-cloud-imds-sdk-python", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "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.1", + "sdkVersion": "0.9.0-alpha.2", "targetBranch": "main" } }, @@ -155,7 +155,7 @@ }, "multiTenant": true, "hooksLocation": { - "bucketKey": "7034/hooks.zip", + "bucketKey": "7096/hooks.zip", "bucketName": "prod-liblab-api-stack-hooks" }, "includeWatermark": false, diff --git a/PyPI_README.md b/PyPI_README.md index 08cd418..52ea9f8 100644 --- a/PyPI_README.md +++ b/PyPI_README.md @@ -1,17 +1,17 @@ -# SaladCloudImdsSdk Python SDK 0.9.0-alpha.1 +# SaladCloudImdsSdk Python SDK 0.9.0-alpha.2 Welcome to the SaladCloudImdsSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudImdsSdk SDK in your project. -## Versions +## Versions - API version: `0.9.0-alpha.1` -- SDK version: `0.9.0-alpha.1` +- SDK version: `0.9.0-alpha.2` -## About the API +## About the API The SaladCloud Instance Metadata Service (IMDS). Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details. -## Table of Contents +## Table of Contents - [Setup & Configuration](#setup--configuration) - [Supported Language Versions](#supported-language-versions) @@ -22,13 +22,13 @@ The SaladCloud Instance Metadata Service (IMDS). Please refer to the [SaladCloud - [Models](#models) - [License](#license) -## Setup & Configuration +## Setup & Configuration -### Supported Language Versions +### Supported Language Versions This SDK is compatible with the following versions: `Python >= 3.7` -### Installation +### Installation To get started with the SDK, we recommend installing using `pip`: @@ -36,7 +36,7 @@ To get started with the SDK, we recommend installing using `pip`: pip install salad-cloud-imds-sdk ``` -## Setting a Custom Timeout +## Setting a Custom Timeout You can set a custom timeout for the SDK's HTTP requests as follows: @@ -46,7 +46,7 @@ from salad_cloud_imds_sdk import SaladCloudImdsSdk sdk = SaladCloudImdsSdk(timeout=10000) ``` -# Sample Usage +# Sample Usage Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint: @@ -64,7 +64,7 @@ print(result) ``` -## Services +## Services The SDK provides various services to interact with the API. @@ -77,7 +77,7 @@ The SDK provides various services to interact with the API. -## Models +## Models The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently. @@ -92,7 +92,7 @@ The SDK includes several models that represent the data structures used in API r -## License +## License This SDK is licensed under the MIT License. diff --git a/README.md b/README.md index 761e3fa..a7509f0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# SaladCloudImdsSdk Python SDK 0.9.0-alpha.1 +# SaladCloudImdsSdk Python SDK 0.9.0-alpha.2 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.1` +- SDK version: `0.9.0-alpha.2` ## About the API diff --git a/documentation/models/ContainerStatus.md b/documentation/models/ContainerStatus.md index d4926a4..2bebfc0 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 | bool | ✅ | `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 | bool | ✅ | `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 | `bool` | ✅ | `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 | `bool` | ✅ | `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 6f30902..b598b70 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 | str | ✅ | 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 | `str` | ✅ | 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 d5094ae..31cf613 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 | str | ✅ | The reason for reallocating the container. This value is reported to SaladCloud support for quality assurance of Salad Nodes. | +| Name | Type | Required | Description | +| :----- | :---- | :------- | :---------------------------------------------------------------------------------------------------------------------------- | +| reason | `str` | ✅ | 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 de971cf..63a92db 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 | -| :----------- | :------------------------------------------------------ | :------- | :---------------- | -| request_body | [ReallocateContainer](../models/ReallocateContainer.md) | ✅ | The request body. | +| Name | Type | Required | Description | +| :----------- | :-------------------------------------------------------- | :------- | :---------------- | +| request_body | `[ReallocateContainer](../models/ReallocateContainer.md)` | ✅ | The request body. | **Example Usage Code Snippet** @@ -33,7 +33,7 @@ sdk = SaladCloudImdsSdk( ) request_body = ReallocateContainer( - reason="commodo" + reason="laborum culpa" ) result = sdk.metadata.reallocate_container(request_body=request_body) diff --git a/documentation/snippets/v1-reallocate-post.md b/documentation/snippets/v1-reallocate-post.md index 3e8479a..c4f0fb4 100644 --- a/documentation/snippets/v1-reallocate-post.md +++ b/documentation/snippets/v1-reallocate-post.md @@ -8,7 +8,7 @@ sdk = SaladCloudImdsSdk( ) request_body = ReallocateContainer( - reason="commodo" + reason="laborum culpa" ) result = sdk.metadata.reallocate_container(request_body=request_body) diff --git a/examples/install.cmd b/examples/install.cmd index 4302e82..d80590c 100644 --- a/examples/install.cmd +++ b/examples/install.cmd @@ -2,4 +2,4 @@ python -m venv .venv call .venv\Scripts\activate pip install build python -m build --outdir dist ..\ -pip install dist\salad_cloud_imds_sdk-0.9.0-alpha.1-py3-none-any.whl --force-reinstall +pip install dist\salad_cloud_imds_sdk-0.9.0-alpha.2-py3-none-any.whl --force-reinstall diff --git a/examples/install.sh b/examples/install.sh index 1032b06..de1e32e 100644 --- a/examples/install.sh +++ b/examples/install.sh @@ -2,4 +2,4 @@ python -m venv .venv . .venv/bin/activate pip install build python -m build --outdir dist ../ -pip install dist/salad_cloud_imds_sdk-0.9.0-alpha.1-py3-none-any.whl --force-reinstall +pip install dist/salad_cloud_imds_sdk-0.9.0-alpha.2-py3-none-any.whl --force-reinstall diff --git a/install.cmd b/install.cmd index e454aea..ab00761 100644 --- a/install.cmd +++ b/install.cmd @@ -15,7 +15,7 @@ if "%USE_VENV%"=="1" ( pip install build python -m build --outdir dist . -pip install dist\salad_cloud_imds_sdk-0.9.0-alpha.1-py3-none-any.whl --force-reinstall +pip install dist\salad_cloud_imds_sdk-0.9.0-alpha.2-py3-none-any.whl --force-reinstall if "%USE_VENV%"=="1" ( deactivate diff --git a/install.sh b/install.sh index f6bb2c3..3106ec4 100644 --- a/install.sh +++ b/install.sh @@ -19,7 +19,7 @@ fi pip install build python -m build --outdir dist . -pip install dist/salad_cloud_imds_sdk-0.9.0-alpha.1-py3-none-any.whl --force-reinstall +pip install dist/salad_cloud_imds_sdk-0.9.0-alpha.2-py3-none-any.whl --force-reinstall if [ "$USE_VENV" -eq 1 ]; then deactivate diff --git a/pyproject.toml b/pyproject.toml index f315b75..239d864 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "salad-cloud-imds-sdk" -version = "0.9.0-alpha.1" +version = "0.9.0-alpha.2" license = { text = "MIT" } description = """The SaladCloud Instance Metadata Service (IMDS). Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details.""" readme = "PyPI_README.md"