Skip to content

Commit

Permalink
liblab SDK update for version v0.9.0-alpha.2
Browse files Browse the repository at this point in the history
  • Loading branch information
seniorquico committed Sep 11, 2024
1 parent e21a0c6 commit 5b9205f
Show file tree
Hide file tree
Showing 13 changed files with 44 additions and 44 deletions.
18 changes: 9 additions & 9 deletions .manifest.json
Original file line number Diff line number Diff line change
@@ -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"],
Expand All @@ -25,15 +25,15 @@
"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": {
"goModuleName": "github.com/saladtechnologies/salad-cloud-imds-sdk-go",
"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": {
Expand All @@ -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": {
Expand Down Expand Up @@ -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": {
Expand All @@ -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"
}
},
Expand Down Expand Up @@ -155,7 +155,7 @@
},
"multiTenant": true,
"hooksLocation": {
"bucketKey": "7034/hooks.zip",
"bucketKey": "7096/hooks.zip",
"bucketName": "prod-liblab-api-stack-hooks"
},
"includeWatermark": false,
Expand Down
26 changes: 13 additions & 13 deletions PyPI_README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# SaladCloudImdsSdk Python SDK 0.9.0-alpha.1
# SaladCloudImdsSdk Python SDK 0.9.0-alpha.2<a id="saladcloudimdssdk-python-sdk-090-alpha2"></a>

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<a id="versions"></a>

- 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<a id="about-the-api"></a>

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<a id="table-of-contents"></a>

- [Setup & Configuration](#setup--configuration)
- [Supported Language Versions](#supported-language-versions)
Expand All @@ -22,21 +22,21 @@ The SaladCloud Instance Metadata Service (IMDS). Please refer to the [SaladCloud
- [Models](#models)
- [License](#license)

## Setup & Configuration
## Setup & Configuration<a id="setup--configuration"></a>

### Supported Language Versions
### Supported Language Versions<a id="supported-language-versions"></a>

This SDK is compatible with the following versions: `Python >= 3.7`

### Installation
### Installation<a id="installation"></a>

To get started with the SDK, we recommend installing using `pip`:

```bash
pip install salad-cloud-imds-sdk
```

## Setting a Custom Timeout
## Setting a Custom Timeout<a id="setting-a-custom-timeout"></a>

You can set a custom timeout for the SDK's HTTP requests as follows:

Expand All @@ -46,7 +46,7 @@ from salad_cloud_imds_sdk import SaladCloudImdsSdk
sdk = SaladCloudImdsSdk(timeout=10000)
```

# Sample Usage
# Sample Usage<a id="sample-usage"></a>

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

Expand All @@ -64,7 +64,7 @@ print(result)

```

## Services
## Services<a id="services"></a>

The SDK provides various services to interact with the API.

Expand All @@ -77,7 +77,7 @@ The SDK provides various services to interact with the API.

</details>

## Models
## Models<a id="models"></a>

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.

Expand All @@ -92,7 +92,7 @@ The SDK includes several models that represent the data structures used in API r

</details>

## License
## License<a id="license"></a>

This SDK is licensed under the MIT License.

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
8 changes: 4 additions & 4 deletions documentation/models/ContainerStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`. |
6 changes: 3 additions & 3 deletions documentation/models/ContainerToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
6 changes: 3 additions & 3 deletions documentation/models/ReallocateContainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
8 changes: 4 additions & 4 deletions documentation/services/MetadataService.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -33,7 +33,7 @@ sdk = SaladCloudImdsSdk(
)

request_body = ReallocateContainer(
reason="commodo"
reason="laborum culpa"
)

result = sdk.metadata.reallocate_container(request_body=request_body)
Expand Down
2 changes: 1 addition & 1 deletion documentation/snippets/v1-reallocate-post.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sdk = SaladCloudImdsSdk(
)

request_body = ReallocateContainer(
reason="commodo"
reason="laborum culpa"
)

result = sdk.metadata.reallocate_container(request_body=request_body)
Expand Down
2 changes: 1 addition & 1 deletion examples/install.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion examples/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion install.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 5b9205f

Please sign in to comment.