# README

Go API client for generated

The administration REST API for IBM Event Streams on Cloud.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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:

import "./generated"

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
DefaultApiCreateTopicPost /admin/topicsCreate a new topic.
DefaultApiDeleteTopicDelete /admin/topics/{topic_name}Delete a topic.
DefaultApiGetTopicGet /admin/topics/{topic_name}Get detailed information on a topic.
DefaultApiListTopicsGet /admin/topicsGet a list of topics.
DefaultApiUpdateTopicPatch /admin/topics/{topic_name}Increase the number of partitions and/or update one or more topic configuration parameters.

Documentation For Models

Documentation For Authorization

APIKeyAuth

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
    Key: "APIKEY",
    Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

BasicAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

TokenAuth

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
    Key: "APIKEY",
    Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author