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 a73d79a commit b1cf82b
Show file tree
Hide file tree
Showing 76 changed files with 1,271 additions and 1,142 deletions.
40 changes: 20 additions & 20 deletions .manifest.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"liblabVersion": "2.1.30",
"date": "2024-09-01T16:26:44.380Z",
"liblabVersion": "2.2.0",
"date": "2024-09-11T04:10:26.923Z",
"config": {
"language": "go",
"apiId": 1094,
"apiId": 1143,
"sdkName": "salad-cloud-sdk",
"sdkVersion": "0.9.0-alpha.1",
"sdkVersion": "0.9.0-alpha.2",
"liblabVersion": "2",
"deliveryMethods": ["zip"],
"languages": ["go"],
Expand All @@ -25,17 +25,17 @@
],
"githubRepoName": "salad-cloud-sdk-dotnet",
"homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-dotnet",
"ignoreFiles": [".gitignore", "LICENSE"],
"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-sdk-go",
"githubRepoName": "salad-cloud-sdk-go",
"ignoreFiles": [".gitignore", "LICENSE"],
"ignoreFiles": [".gitignore", "./LICENSE"],
"liblabVersion": "2",
"sdkVersion": "0.9.0-alpha.1",
"sdkVersion": "0.9.0-alpha.2",
"targetBranch": "main"
},
"java": {
Expand All @@ -57,9 +57,9 @@
],
"githubRepoName": "salad-cloud-sdk-java",
"homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-java",
"ignoreFiles": [".gitignore", "LICENSE"],
"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,9 +100,9 @@
}
],
"githubRepoName": "salad-cloud-sdk-python",
"ignoreFiles": [".gitignore", "LICENSE"],
"ignoreFiles": [".gitignore", "./LICENSE"],
"liblabVersion": "2",
"sdkVersion": "0.9.0-alpha.1",
"sdkVersion": "0.9.0-alpha.2",
"targetBranch": "main"
},
"terraform": {
Expand All @@ -113,9 +113,9 @@
"providerSchemaConfig": {
"authTokenKey": "api_key"
},
"providerVersion": "0.9.0-alpha.1",
"providerVersion": "0.9.0-alpha.2",
"githubRepoName": "terraform-provider-salad-cloud",
"ignoreFiles": [".gitignore", "LICENSE"],
"ignoreFiles": [".gitignore", "./LICENSE"],
"liblabVersion": "2",
"targetBranch": "main"
},
Expand All @@ -137,9 +137,9 @@
],
"githubRepoName": "salad-cloud-sdk-javascript",
"homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-javascript",
"ignoreFiles": [".gitignore", "LICENSE"],
"ignoreFiles": [".gitignore", "./LICENSE"],
"liblabVersion": "2",
"sdkVersion": "0.9.0-alpha.1",
"sdkVersion": "0.9.0-alpha.2",
"targetBranch": "main"
}
},
Expand Down Expand Up @@ -233,7 +233,7 @@
}
],
"apiName": "SaladCloud API",
"apiVersion": "0.9.0-alpha.1",
"apiVersion": "0.9.0-alpha.2",
"authentication": {
"apiKey": {
"header": "Salad-Api-Key"
Expand Down Expand Up @@ -264,7 +264,7 @@
"includeWatermark": false,
"goModuleName": "github.com/saladtechnologies/salad-cloud-sdk-go",
"githubRepoName": "salad-cloud-sdk-go",
"ignoreFiles": [".gitignore", "LICENSE"],
"ignoreFiles": [".gitignore", "./LICENSE"],
"targetBranch": "main",
"deliveryMethod": "zip",
"hooks": {
Expand Down Expand Up @@ -313,7 +313,6 @@
"pkg/inferenceendpoints/request_params.go",
"internal/clients/rest/hooks/hook.go",
"internal/clients/rest/hooks/default_hook.go",
"internal/clients/rest/handlers/default_headers_handler.go",
"internal/clients/rest/handlers/api_key_handler.go",
"internal/clients/rest/handlers/retry_handler.go",
"internal/clients/rest/handlers/request_validation_handler.go",
Expand All @@ -330,7 +329,6 @@
"pkg/shared/salad_cloud_sdk_response.go",
"pkg/shared/salad_cloud_sdk_error.go",
"pkg/saladcloudsdkconfig/environments.go",
"./LICENSE",
".env.example",
"documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-get.md",
"documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-post.md",
Expand Down Expand Up @@ -391,6 +389,7 @@
"documentation/models/container_group_readiness_probe.md",
"documentation/models/container_group_startup_probe.md",
"documentation/models/container_group_queue_connection.md",
"documentation/models/queue_autoscaler.md",
"documentation/models/container_resource_requirements.md",
"documentation/models/container_group_priority.md",
"documentation/models/container_group_status.md",
Expand Down Expand Up @@ -446,6 +445,7 @@
"pkg/shared/container_group_readiness_probe.go",
"pkg/shared/container_group_startup_probe.go",
"pkg/shared/container_group_queue_connection.go",
"pkg/shared/queue_autoscaler.go",
"pkg/shared/container_resource_requirements.go",
"pkg/shared/container_group_instance_status_count.go",
"pkg/shared/container_group_probe_tcp.go",
Expand Down
47 changes: 44 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# SaladCloudSdk Go SDK 0.9.0-alpha.1
# SaladCloudSdk Go SDK 0.9.0-alpha.2

Welcome to the SaladCloudSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudSdk SDK in your project.

## Versions

- API version: `0.9.0-alpha.1`
- SDK version: `0.9.0-alpha.1`
- API version: `0.9.0-alpha.2`
- SDK version: `0.9.0-alpha.2`

## About the API

Expand All @@ -19,6 +19,7 @@ The SaladCloud REST API. Please refer to the [SaladCloud API Documentation](http
- [Authentication](#authentication)
- [API Key Authentication](#api-key-authentication)
- [Services](#services)
- [Response Wrappers](#response-wrappers)
- [Models](#models)
- [License](#license)

Expand Down Expand Up @@ -83,6 +84,45 @@ The SDK provides various services to interact with the API.

</details>

### Response Wrappers

All services use response wrappers to provide a consistent interface to return the responses from the API.

The response wrapper itself is a generic struct that contains the response data and metadata.

<details>
<summary>Below are the response wrappers used in the SDK:</summary>

#### `SaladCloudSdkResponse[T]`

This response wrapper is used to return the response data from the API. It contains the following fields:

| Name | Type | Description |
| :------- | :------------------------------ | :------------------------------------------ |
| Data | `T` | The body of the API response |
| Metadata | `SaladCloudSdkResponseMetadata` | Status code and headers returned by the API |

#### `SaladCloudSdkError`

This response wrapper is used to return an error. It contains the following fields:

| Name | Type | Description |
| :------- | :------------------------------ | :------------------------------------------ |
| Err | `error` | The error that occurred |
| Body | `T` | The body of the API response |
| Metadata | `SaladCloudSdkResponseMetadata` | Status code and headers returned by the API |

#### `SaladCloudSdkResponseMetadata`

This struct is shared by both response wrappers and contains the following fields:

| Name | Type | Description |
| :--------- | :------------------ | :----------------------------------------------- |
| Headers | `map[string]string` | A map containing the headers returned by the API |
| StatusCode | `int` | The status code returned by the API |

</details>

## 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.
Expand Down Expand Up @@ -123,6 +163,7 @@ The SDK includes several models that represent the data structures used in API r
| [ContainerGroupReadinessProbe](documentation/models/container_group_readiness_probe.md) | Represents the container group readiness probe |
| [ContainerGroupStartupProbe](documentation/models/container_group_startup_probe.md) | Represents the container group startup probe |
| [ContainerGroupQueueConnection](documentation/models/container_group_queue_connection.md) | Represents container group queue connection |
| [QueueAutoscaler](documentation/models/queue_autoscaler.md) | Represents the autoscaling rules for a queue |
| [ContainerResourceRequirements](documentation/models/container_resource_requirements.md) | Represents a container resource requirements |
| [ContainerGroupPriority](documentation/models/container_group_priority.md) | |
| [ContainerGroupStatus](documentation/models/container_group_status.md) | |
Expand Down
Loading

0 comments on commit b1cf82b

Please sign in to comment.