https://github.com/ionos-cloud/sdk-go-cdn
https://github.com/ionos-cloud/sdk-go-cdn
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ionos-cloud/sdk-go-cdn
- Owner: ionos-cloud
- License: apache-2.0
- Created: 2024-07-26T08:00:43.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-10-22T13:51:33.000Z (6 months ago)
- Last Synced: 2024-12-26T08:27:34.588Z (4 months ago)
- Size: 69.3 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go API client for ionoscloud
This API manages CDN distributions.
## 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: 1.2.0
- Package version: 1.2.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/net/context
```
Put the package under your project folder and add the following in import:
```golang
import ionoscloud "github.com/ionos-cloud/sdk-go-cdn"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```golang
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```
## Configuration of Server URL
Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.
### Select Server Configuration
For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.
```golang
ctx := context.WithValue(context.Background(), ionoscloud.ContextServerIndex, 1)
```
### Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.
```golang
ctx := context.WithValue(context.Background(), ionoscloud.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```
Note, enum values are always validated and all unused variables are silently ignored.
## Documentation for API Endpoints
All URIs are relative to *https://cdn.de-fra.ionos.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DistributionsApi* | [**DistributionsDelete**](docs/api/DistributionsApi.md#distributionsdelete) | **Delete** /distributions/{distributionId} | Delete Distribution
*DistributionsApi* | [**DistributionsFindById**](docs/api/DistributionsApi.md#distributionsfindbyid) | **Get** /distributions/{distributionId} | Retrieve Distribution
*DistributionsApi* | [**DistributionsGet**](docs/api/DistributionsApi.md#distributionsget) | **Get** /distributions | Retrieve all Distributions
*DistributionsApi* | [**DistributionsPost**](docs/api/DistributionsApi.md#distributionspost) | **Post** /distributions | Create Distribution
*DistributionsApi* | [**DistributionsPut**](docs/api/DistributionsApi.md#distributionsput) | **Put** /distributions/{distributionId} | Ensure Distribution
## Documentation For Models
- [Distribution](docs/models/Distribution.md)
- [DistributionCreate](docs/models/DistributionCreate.md)
- [DistributionMetadata](docs/models/DistributionMetadata.md)
- [DistributionProperties](docs/models/DistributionProperties.md)
- [DistributionUpdate](docs/models/DistributionUpdate.md)
- [Distributions](docs/models/Distributions.md)
- [DistributionsAllOf](docs/models/DistributionsAllOf.md)
- [Error](docs/models/Error.md)
- [ErrorMessages](docs/models/ErrorMessages.md)
- [IpAddresses](docs/models/IpAddresses.md)
- [Links](docs/models/Links.md)
- [Metadata](docs/models/Metadata.md)
- [Pagination](docs/models/Pagination.md)
- [ResourceState](docs/models/ResourceState.md)
- [RoutingRule](docs/models/RoutingRule.md)
- [Upstream](docs/models/Upstream.md)
- [UpstreamGeoRestrictions](docs/models/UpstreamGeoRestrictions.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### tokenAuth
- **Type**: HTTP Bearer token authentication
Example
```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
```
## Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:
* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`
## Author