Skip to content

Commit

Permalink
Merge pull request #98 from Leaseweb/feat/implement-ips
Browse files Browse the repository at this point in the history
feat: implement ips submodule
  • Loading branch information
alrayyes authored Dec 27, 2024
2 parents d20b073 + f162c8c commit e651ced
Show file tree
Hide file tree
Showing 52 changed files with 12,085 additions and 0 deletions.
24 changes: 24 additions & 0 deletions ips/.gitignore
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
23 changes: 23 additions & 0 deletions ips/.openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
49 changes: 49 additions & 0 deletions ips/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.gitignore
.openapi-generator-ignore
.travis.yml
README.md
api/openapi.yaml
api_ips.go
client.go
configuration.go
docs/AssignedContract.md
docs/ErrorResult.md
docs/GetIPListResult.md
docs/GetNullRouteHistoryListResult.md
docs/GetReverseLookupRecordListResult.md
docs/Ip.md
docs/IpType.md
docs/IpsAPI.md
docs/Metadata.md
docs/NullRouteIPOpts.md
docs/NullRoutedIP.md
docs/ProtocolVersion.md
docs/ReverseLookup.md
docs/Subnet.md
docs/UpdateIPOpts.md
docs/UpdateNullRouteOpts.md
docs/UpdateReverseLookupRecordsOpts.md
docs/UpdateReverseLookupRecordsResult.md
git_push.sh
go.mod
go.sum
model__metadata.go
model_assigned_contract.go
model_error_result.go
model_get_ip_list_result.go
model_get_null_route_history_list_result.go
model_get_reverse_lookup_record_list_result.go
model_ip.go
model_ip_type.go
model_null_route_ip_opts.go
model_null_routed_ip.go
model_protocol_version.go
model_reverse_lookup.go
model_subnet.go
model_update_ip_opts.go
model_update_null_route_opts.go
model_update_reverse_lookup_records_opts.go
model_update_reverse_lookup_records_result.go
response.go
test/api_ips_test.go
utils.go
1 change: 1 addition & 0 deletions ips/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7.10.0
8 changes: 8 additions & 0 deletions ips/.travis.yml
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 ./

170 changes: 170 additions & 0 deletions ips/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
# Go API client for ips

> The base URL for this API is: **https://api.leaseweb.com/ipMgmt/v2/_**
## 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 ips "github.com/leaseweb/leaseweb-go-sdk/ips"
```

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

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

### Templated Server URL

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

```go
ctx := context.WithValue(context.Background(), ips.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 `ips.ContextOperationServerIndices` and `ips.ContextOperationServerVariables` context maps.

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

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*IpsAPI* | [**GetIP**](docs/IpsAPI.md#getip) | **Get** /ips/{ip} | Inspect an IP
*IpsAPI* | [**GetIPList**](docs/IpsAPI.md#getiplist) | **Get** /ips | List IPs
*IpsAPI* | [**GetNullRouteHistory**](docs/IpsAPI.md#getnullroutehistory) | **Get** /nullRoutes/{id} | Inspect null route history
*IpsAPI* | [**GetNullRouteHistoryList**](docs/IpsAPI.md#getnullroutehistorylist) | **Get** /nullRoutes | Inspect null route history
*IpsAPI* | [**GetReverseLookupRecordList**](docs/IpsAPI.md#getreverselookuprecordlist) | **Get** /ips/{ip}/reverseLookup | List reverse lookup records for an IPv6 range
*IpsAPI* | [**NullRouteIP**](docs/IpsAPI.md#nullrouteip) | **Post** /ips/{ip}/nullRoute | Null route an IP
*IpsAPI* | [**RemoveIPNullRoute**](docs/IpsAPI.md#removeipnullroute) | **Delete** /ips/{ip}/nullRoute | Remove a null route
*IpsAPI* | [**UpdateIP**](docs/IpsAPI.md#updateip) | **Put** /ips/{ip} | Update an IP
*IpsAPI* | [**UpdateNullRoute**](docs/IpsAPI.md#updatenullroute) | **Put** /nullRoutes/{id} | Update a null route
*IpsAPI* | [**UpdateReverseLookupRecords**](docs/IpsAPI.md#updatereverselookuprecords) | **Put** /ips/{ip}/reverseLookup | Set or remove reverse lookup records for an IPv6 range


## Documentation For Models

- [AssignedContract](docs/AssignedContract.md)
- [ErrorResult](docs/ErrorResult.md)
- [GetIPListResult](docs/GetIPListResult.md)
- [GetNullRouteHistoryListResult](docs/GetNullRouteHistoryListResult.md)
- [GetReverseLookupRecordListResult](docs/GetReverseLookupRecordListResult.md)
- [Ip](docs/Ip.md)
- [IpType](docs/IpType.md)
- [Metadata](docs/Metadata.md)
- [NullRouteIPOpts](docs/NullRouteIPOpts.md)
- [NullRoutedIP](docs/NullRoutedIP.md)
- [ProtocolVersion](docs/ProtocolVersion.md)
- [ReverseLookup](docs/ReverseLookup.md)
- [Subnet](docs/Subnet.md)
- [UpdateIPOpts](docs/UpdateIPOpts.md)
- [UpdateNullRouteOpts](docs/UpdateNullRouteOpts.md)
- [UpdateReverseLookupRecordsOpts](docs/UpdateReverseLookupRecordsOpts.md)
- [UpdateReverseLookupRecordsResult](docs/UpdateReverseLookupRecordsResult.md)


## Documentation For Authorization


Authentication schemes defined for the API:
### BearerAuth

- **Type**: HTTP Bearer token authentication

Example

```go
auth := context.WithValue(context.Background(), ips.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(),
ips.ContextAPIKeys,
map[string]ips.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 e651ced

Please sign in to comment.