README.md

Go API client for openapi

The Open Service Broker API defines an HTTP(S) interface between Platforms and Service Brokers.

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: master - might contain changes that are not yet released
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.openservicebrokerapi.org/

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 "./openapi"

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

Class	Method	HTTP request	Description
CatalogApi	CatalogGet	Get /v2/catalog	get the catalog of services that the service broker offers
ServiceBindingsApi	ServiceBindingBinding	Put /v2/service_instances/{instance_id}/service_bindings/{binding_id}	generation of a service binding
ServiceBindingsApi	ServiceBindingGet	Get /v2/service_instances/{instance_id}/service_bindings/{binding_id}	gets a service binding
ServiceBindingsApi	ServiceBindingLastOperationGet	Get /v2/service_instances/{instance_id}/service_bindings/{binding_id}/last_operation	last requested operation state for service binding
ServiceBindingsApi	ServiceBindingUnbinding	Delete /v2/service_instances/{instance_id}/service_bindings/{binding_id}	deprovision of a service binding
ServiceInstancesApi	ServiceInstanceDeprovision	Delete /v2/service_instances/{instance_id}	deprovision a service instance
ServiceInstancesApi	ServiceInstanceGet	Get /v2/service_instances/{instance_id}	gets a service instance
ServiceInstancesApi	ServiceInstanceLastOperationGet	Get /v2/service_instances/{instance_id}/last_operation	last requested operation state for service instance
ServiceInstancesApi	ServiceInstanceProvision	Put /v2/service_instances/{instance_id}	provision a service instance
ServiceInstancesApi	ServiceInstanceUpdate	Patch /v2/service_instances/{instance_id}	update a service instance

Documentation For Models

• AsyncOperation
• Catalog
• DashboardClient
• Error
• LastOperationResource
• MaintenanceInfo
• Plan
• SchemaParameters
• SchemasObject
• Service
• ServiceBindingRequest
• ServiceBindingResource
• ServiceBindingResourceObject
• ServiceBindingResponse
• ServiceBindingSchemaObject
• ServiceBindingVolumeMount
• ServiceBindingVolumeMountDevice
• ServiceInstanceAsyncOperation
• ServiceInstancePreviousValues
• ServiceInstanceProvisionRequest
• ServiceInstanceProvisionResponse
• ServiceInstanceResource
• ServiceInstanceSchemaObject
• ServiceInstanceUpdateRequest

Documentation For Authorization

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)

Author

open-service-broker-api@googlegroups.com