https://github.com/saladtechnologies/salad-cloud-imds-sdk-go
SaladCloud IMDS SDK for Go
https://github.com/saladtechnologies/salad-cloud-imds-sdk-go
Last synced: 8 months ago
JSON representation
SaladCloud IMDS SDK for Go
- Host: GitHub
- URL: https://github.com/saladtechnologies/salad-cloud-imds-sdk-go
- Owner: SaladTechnologies
- License: mit
- Created: 2024-09-05T22:07:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-05T04:30:14.000Z (about 1 year ago)
- Last Synced: 2025-02-16T16:59:00.415Z (8 months ago)
- Language: Go
- Size: 53.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# SaladCloudImdsSdk Go SDK 0.9.0-alpha.4
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.4`
## 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
- [Setup & Configuration](#setup--configuration)
- [Supported Language Versions](#supported-language-versions)
- [Installation](#installation)
- [Services](#services)
- [Response Wrappers](#response-wrappers)
- [Models](#models)
- [License](#license)
# Setup & Configuration
## Supported Language Versions
This SDK is compatible with the following versions: `Go >= 1.19.0`
## Services
The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
| Name |
| :------------------------------------------------------------ |
| [MetadataService](documentation/services/metadata_service.md) |
### 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.
Below are the response wrappers used in the SDK:
#### `SaladCloudImdsSdkResponse[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 | `SaladCloudImdsSdkResponseMetadata` | Status code and headers returned by the API |
#### `SaladCloudImdsSdkError`
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 | `SaladCloudImdsSdkResponseMetadata` | Status code and headers returned by the API |
#### `SaladCloudImdsSdkResponseMetadata`
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 |
## 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.
Below is a list of all available models with links to their detailed documentation:
| Name | Description |
| :------------------------------------------------------------------ | :------------------------------------------------------- |
| [ReallocateContainer](documentation/models/reallocate_container.md) | Represents a request to reallocate a container. |
| [ContainerStatus](documentation/models/container_status.md) | Represents the health statuses of the running container. |
| [ContainerToken](documentation/models/container_token.md) | Represents the identity token of the running container. |
## License
This SDK is licensed under the MIT License.
See the [LICENSE](LICENSE) file for more details.