-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6dd8079
commit d4235d5
Showing
83 changed files
with
17,828 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Compiled Object files, Static and Dynamic libs (Shared Objects) | ||
*.o | ||
*.a | ||
*.so | ||
|
||
# Folders | ||
_obj | ||
_test | ||
|
||
# Architecture specific extensions/prefixes | ||
*.[568vq] | ||
[568vq].out | ||
|
||
*.cgo1.go | ||
*.cgo2.c | ||
_cgo_defun.c | ||
_cgo_gotypes.go | ||
_cgo_export.* | ||
|
||
_testmain.go | ||
|
||
*.exe | ||
*.test | ||
*.prof |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
language: go | ||
|
||
install: | ||
- go get -d -v . | ||
|
||
script: | ||
- go build -v ./ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
[![Gitter](https://img.shields.io/gitter/room/ionos-cloud/sdk-general)](https://gitter.im/ionos-cloud/sdk-general) | ||
|
||
# Go API client for ionoscloud | ||
|
||
Object Storage Management API is a RESTful API that manages the object storage | ||
service configuration for IONOS Cloud. | ||
|
||
|
||
## Overview | ||
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. | ||
|
||
- API version: 0.1.0 | ||
- Package version: 1.0.0 | ||
- Build package: org.openapitools.codegen.languages.GoClientCodegen | ||
|
||
## Installation | ||
|
||
Install the following dependencies: | ||
|
||
```shell | ||
go get github.com/stretchr/testify/assert | ||
go get golang.org/x/oauth2 | ||
go get golang.org/x/net/context | ||
go get github.com/antihax/optional | ||
``` | ||
|
||
Put the package under your project folder and add the following in import: | ||
|
||
```golang | ||
import "./ionoscloud" | ||
``` | ||
|
||
## Authentication | ||
|
||
All available server URLs are: | ||
|
||
- *https://s3.ionos.com* - Production | ||
|
||
By default, *https://s3.ionos.com* is used, however this can be overriden at authentication, either | ||
by setting the `IONOS_API_URL` environment variable or by specifying the `hostUrl` parameter when | ||
initializing the sdk client. | ||
|
||
The username and password or the authentication token can be manually specified when initializing | ||
the sdk client: | ||
|
||
```golang | ||
|
||
client := ionoscloud.NewAPIClient(ionoscloud.NewConfiguration(username, password, token, hostUrl)) | ||
|
||
``` | ||
|
||
Environment variables can also be used. The sdk uses the following variables: | ||
- IONOS_TOKEN - login via token. This is the recommended way to authenticate. | ||
- IONOS_USERNAME - to specify the username used to login | ||
- IONOS_PASSWORD - to specify the password | ||
- IONOS_API_URL - to specify the API server URL | ||
|
||
In this case, the client configuration needs to be initialized using `NewConfigurationFromEnv()`. | ||
|
||
```golang | ||
|
||
client := ionoscloud.NewAPIClient(ionoscloud.NewConfigurationFromEnv()) | ||
|
||
``` | ||
|
||
|
||
## Documentation for API Endpoints | ||
|
||
All URIs are relative to *https://s3.ionos.com* | ||
<details > | ||
<summary title="Click to toggle">API Endpoints table</summary> | ||
|
||
|
||
| Class | Method | HTTP request | Description | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| AccesskeysApi | [**AccesskeysDelete**](docs/api/AccesskeysApi.md#AccesskeysDelete) | **Delete** /accesskeys/{accesskeyId} | Delete AccessKey | | ||
| AccesskeysApi | [**AccesskeysFindById**](docs/api/AccesskeysApi.md#AccesskeysFindById) | **Get** /accesskeys/{accesskeyId} | Retrieve AccessKey | | ||
| AccesskeysApi | [**AccesskeysGet**](docs/api/AccesskeysApi.md#AccesskeysGet) | **Get** /accesskeys | Retrieve all Accesskeys | | ||
| AccesskeysApi | [**AccesskeysPost**](docs/api/AccesskeysApi.md#AccesskeysPost) | **Post** /accesskeys | Create AccessKey | | ||
| AccesskeysApi | [**AccesskeysPut**](docs/api/AccesskeysApi.md#AccesskeysPut) | **Put** /accesskeys/{accesskeyId} | Ensure AccessKey | | ||
| AccesskeysApi | [**AccesskeysRenew**](docs/api/AccesskeysApi.md#AccesskeysRenew) | **Put** /accesskeys/{accesskeyId}/renew | Ensure AccessKey | | ||
| RegionsApi | [**RegionsFindByRegion**](docs/api/RegionsApi.md#RegionsFindByRegion) | **Get** /regions/{region} | Retrieve Region | | ||
| RegionsApi | [**RegionsGet**](docs/api/RegionsApi.md#RegionsGet) | **Get** /regions | Retrieve all Regions | | ||
|
||
</details> | ||
|
||
## Documentation For Models | ||
|
||
All URIs are relative to *https://s3.ionos.com* | ||
<details > | ||
<summary title="Click to toggle">API models list</summary> | ||
|
||
- [AccessKey](docs/models/AccessKey) | ||
- [AccessKeyCreate](docs/models/AccessKeyCreate) | ||
- [AccessKeyEnsure](docs/models/AccessKeyEnsure) | ||
- [AccessKeyRead](docs/models/AccessKeyRead) | ||
- [AccessKeyReadList](docs/models/AccessKeyReadList) | ||
- [AccessKeyReadListAllOf](docs/models/AccessKeyReadListAllOf) | ||
- [Bucket](docs/models/Bucket) | ||
- [BucketCreate](docs/models/BucketCreate) | ||
- [BucketEnsure](docs/models/BucketEnsure) | ||
- [BucketRead](docs/models/BucketRead) | ||
- [BucketReadList](docs/models/BucketReadList) | ||
- [BucketReadListAllOf](docs/models/BucketReadListAllOf) | ||
- [Error](docs/models/Error) | ||
- [ErrorMessages](docs/models/ErrorMessages) | ||
- [Links](docs/models/Links) | ||
- [Metadata](docs/models/Metadata) | ||
- [MetadataWithStatus](docs/models/MetadataWithStatus) | ||
- [MetadataWithStatusAllOf](docs/models/MetadataWithStatusAllOf) | ||
- [MetadataWithSupportedRegions](docs/models/MetadataWithSupportedRegions) | ||
- [MetadataWithSupportedRegionsAllOf](docs/models/MetadataWithSupportedRegionsAllOf) | ||
- [Pagination](docs/models/Pagination) | ||
- [Region](docs/models/Region) | ||
- [RegionCapability](docs/models/RegionCapability) | ||
- [RegionCreate](docs/models/RegionCreate) | ||
- [RegionEnsure](docs/models/RegionEnsure) | ||
- [RegionRead](docs/models/RegionRead) | ||
- [RegionReadList](docs/models/RegionReadList) | ||
- [RegionReadListAllOf](docs/models/RegionReadListAllOf) | ||
- [StorageClass](docs/models/StorageClass) | ||
- [StorageClassCreate](docs/models/StorageClassCreate) | ||
- [StorageClassEnsure](docs/models/StorageClassEnsure) | ||
- [StorageClassRead](docs/models/StorageClassRead) | ||
- [StorageClassReadList](docs/models/StorageClassReadList) | ||
- [StorageClassReadListAllOf](docs/models/StorageClassReadListAllOf) | ||
|
||
|
||
[[Back to API list]](#documentation-for-api-endpoints) [[Back to Model list]](#documentation-for-models) | ||
|
||
</details> |
Oops, something went wrong.