Skip to content

Commit

Permalink
Add CLI SDK (#27)
Browse files Browse the repository at this point in the history
* add cli sdk

* remove .idea

* rename module

* go mod tidy
  • Loading branch information
brianstrauch authored May 4, 2022
1 parent ff8ddcb commit dfb11f1
Show file tree
Hide file tree
Showing 24 changed files with 6,181 additions and 0 deletions.
5 changes: 5 additions & 0 deletions cli/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module github.com/confluentinc/ccloud-sdk-go-v2/cli

go 1.13

require golang.org/x/oauth2 v0.0.0-20210218202405-ba52d332ba99
362 changes: 362 additions & 0 deletions cli/go.sum

Large diffs are not rendered by default.

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

API to collect data on CLI commands run while logged in to Confluent 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
For more information, please visit [https://confluent.slack.com/app_redirect?channel=cli-eng](https://confluent.slack.com/app_redirect?channel=cli-eng)

## 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
```

Put the package under your project folder and add the following in import:

```golang
import sw "./v1"
```

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(), sw.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(), sw.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 `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.

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

## Documentation for API Endpoints

All URIs are relative to *https://api.confluent.cloud*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*UsagesCliV1Api* | [**CreateCliV1Usage**](docs/UsagesCliV1Api.md#createcliv1usage) | **Post** /cli/v1/usages | Create a Usage


## Documentation For Models

- [CliV1Usage](docs/CliV1Usage.md)
- [Error](docs/Error.md)
- [ErrorSource](docs/ErrorSource.md)
- [Failure](docs/Failure.md)
- [ListMeta](docs/ListMeta.md)
- [ObjectMeta](docs/ObjectMeta.md)
- [ObjectReference](docs/ObjectReference.md)


## Documentation For Authorization



### api-key

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
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

[email protected]

Loading

0 comments on commit dfb11f1

Please sign in to comment.