Skip to content

Commit

Permalink
fix(doc); add missing sdk README files
Browse files Browse the repository at this point in the history
  • Loading branch information
Leaseweb CI committed Nov 27, 2024
1 parent 51422f2 commit 4bc6a7a
Show file tree
Hide file tree
Showing 6 changed files with 873 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ func main() {
### Documentation
The Leaseweb Go SDK documentation based on product:

- [Public Cloud](publiccloud/docs/PubliccloudAPI.md)
- [Dedicated Server](dedicatedserver/docs/DedicatedserverAPI.md)
- [Aggregation Pack](aggregationpack/docs/AggregationpackAPI.md)
- [Abuse](abuse/docs/AbuseAPI.md)
- [Invoice](invoice/docs/InvoiceAPI.md)
- [Public Cloud](publiccloud/README.md)
- [Dedicated Server](dedicatedserver/README.md)
- [Aggregation Pack](aggregationpack/README.md)
- [Abuse](abuse/README.md)
- [Invoice](invoice/README.md)

### Issues
If you encounter an issue with the project, you are welcome to submit an [issue](https://github.com/Leaseweb/leaseweb-go-sdk/issues).
Expand Down
2 changes: 1 addition & 1 deletion abuse/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat

- API version: v1
- Package version: 1.0.0
- Generator version: 7.4.0
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen

## Installation
Expand Down
152 changes: 152 additions & 0 deletions aggregationpack/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
# Go API client for aggregationpack

This documents the rest api aggregation packs provides.

## 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: v2
- Package version: 1.0.0
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen

## Installation

Install the following dependencies:

```sh
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:

```go
import aggregationpack "github.com/leaseweb/leaseweb-go-sdk/aggregationpack"
```

To use a proxy, set the environment variable `HTTP_PROXY`:

```go
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 `aggregationpack.ContextServerIndex` of type `int`.

```go
ctx := context.WithValue(context.Background(), aggregationpack.ContextServerIndex, 1)
```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `aggregationpack.ContextServerVariables` of type `map[string]string`.

```go
ctx := context.WithValue(context.Background(), aggregationpack.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `aggregationpack.ContextOperationServerIndices` and `aggregationpack.ContextOperationServerVariables` context maps.

```go
ctx := context.WithValue(context.Background(), aggregationpack.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), aggregationpack.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```

## Documentation for API Endpoints

All URIs are relative to *https://api.leaseweb.com/bareMetals/v2*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AggregationpackAPI* | [**GetAggregationPack**](docs/AggregationpackAPI.md#getaggregationpack) | **Get** /aggregationPacks/{aggregationPackId} | Get aggregation pack
*AggregationpackAPI* | [**GetAggregationPackList**](docs/AggregationpackAPI.md#getaggregationpacklist) | **Get** /aggregationPacks | List aggregation packs


## Documentation For Models

- [AggregationPack](docs/AggregationPack.md)
- [AggregationType](docs/AggregationType.md)
- [DataTrafficCommitUnit](docs/DataTrafficCommitUnit.md)
- [ErrorResult](docs/ErrorResult.md)
- [GetAggregationPackListResult](docs/GetAggregationPackListResult.md)
- [Metadata](docs/Metadata.md)
- [NetworkPerformanceType](docs/NetworkPerformanceType.md)


## Documentation For Authorization


Authentication schemes defined for the API:
### BearerAuth

- **Type**: HTTP Bearer token authentication

Example

```go
auth := context.WithValue(context.Background(), aggregationpack.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
```

### X-LSW-Auth

- **Type**: API key
- **API key parameter name**: X-LSW-Auth
- **Location**: HTTP header

Note, each API key must be added to a map of `map[string]APIKey` where the key is: X-LSW-Auth and passed in as the auth context for each request.

Example

```go
auth := context.WithValue(
context.Background(),
aggregationpack.ContextAPIKeys,
map[string]aggregationpack.APIKey{
"X-LSW-Auth": {Key: "API_KEY_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



Loading

0 comments on commit 4bc6a7a

Please sign in to comment.