# Rust API client for rocl

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](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) 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.RustClientCodegen
For more information, please visit [https://www.openservicebrokerapi.org/](https://www.openservicebrokerapi.org/)

## Installation

Put the package under your project folder and add the following to `Cargo.toml` under `[dependencies]`:

```
    openapi = { path = "./generated" }
```

## Documentation for API Endpoints

All URIs are relative to *http://example.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CatalogApi* | [**catalog_get**](docs/CatalogApi.md#catalog_get) | **get** /v2/catalog | get the catalog of services that the service broker offers
*ServiceBindingsApi* | [**service_binding_binding**](docs/ServiceBindingsApi.md#service_binding_binding) | **put** /v2/service_instances/{instance_id}/service_bindings/{binding_id} | generate a service binding
*ServiceBindingsApi* | [**service_binding_get**](docs/ServiceBindingsApi.md#service_binding_get) | **get** /v2/service_instances/{instance_id}/service_bindings/{binding_id} | get a service binding
*ServiceBindingsApi* | [**service_binding_last_operation_get**](docs/ServiceBindingsApi.md#service_binding_last_operation_get) | **get** /v2/service_instances/{instance_id}/service_bindings/{binding_id}/last_operation | get the last requested operation state for service binding
*ServiceBindingsApi* | [**service_binding_unbinding**](docs/ServiceBindingsApi.md#service_binding_unbinding) | **delete** /v2/service_instances/{instance_id}/service_bindings/{binding_id} | deprovision a service binding
*ServiceInstancesApi* | [**service_instance_deprovision**](docs/ServiceInstancesApi.md#service_instance_deprovision) | **delete** /v2/service_instances/{instance_id} | deprovision a service instance
*ServiceInstancesApi* | [**service_instance_get**](docs/ServiceInstancesApi.md#service_instance_get) | **get** /v2/service_instances/{instance_id} | get a service instance
*ServiceInstancesApi* | [**service_instance_last_operation_get**](docs/ServiceInstancesApi.md#service_instance_last_operation_get) | **get** /v2/service_instances/{instance_id}/last_operation | get the last requested operation state for service instance
*ServiceInstancesApi* | [**service_instance_provision**](docs/ServiceInstancesApi.md#service_instance_provision) | **put** /v2/service_instances/{instance_id} | provision a service instance
*ServiceInstancesApi* | [**service_instance_update**](docs/ServiceInstancesApi.md#service_instance_update) | **patch** /v2/service_instances/{instance_id} | update a service instance


## Documentation For Models

 - [AsyncOperation](docs/AsyncOperation.md)
 - [Catalog](docs/Catalog.md)
 - [DashboardClient](docs/DashboardClient.md)
 - [Error](docs/Error.md)
 - [LastOperationResource](docs/LastOperationResource.md)
 - [MaintenanceInfo](docs/MaintenanceInfo.md)
 - [Plan](docs/Plan.md)
 - [Schemas](docs/Schemas.md)
 - [Service](docs/Service.md)
 - [ServiceBindingEndpoint](docs/ServiceBindingEndpoint.md)
 - [ServiceBindingMetadata](docs/ServiceBindingMetadata.md)
 - [ServiceBindingRequest](docs/ServiceBindingRequest.md)
 - [ServiceBindingResouceObject](docs/ServiceBindingResouceObject.md)
 - [ServiceBindingResource](docs/ServiceBindingResource.md)
 - [ServiceBindingResponse](docs/ServiceBindingResponse.md)
 - [ServiceBindingSchema](docs/ServiceBindingSchema.md)
 - [ServiceBindingVolumeMount](docs/ServiceBindingVolumeMount.md)
 - [ServiceBindingVolumeMountDevice](docs/ServiceBindingVolumeMountDevice.md)
 - [ServiceInstanceAsyncOperation](docs/ServiceInstanceAsyncOperation.md)
 - [ServiceInstanceMetadata](docs/ServiceInstanceMetadata.md)
 - [ServiceInstancePreviousValues](docs/ServiceInstancePreviousValues.md)
 - [ServiceInstanceProvisionRequestBody](docs/ServiceInstanceProvisionRequestBody.md)
 - [ServiceInstanceProvisionResponse](docs/ServiceInstanceProvisionResponse.md)
 - [ServiceInstanceResource](docs/ServiceInstanceResource.md)
 - [ServiceInstanceSchema](docs/ServiceInstanceSchema.md)
 - [ServiceInstanceSchemaCreate](docs/ServiceInstanceSchemaCreate.md)
 - [ServiceInstanceUpdateRequestBody](docs/ServiceInstanceUpdateRequestBody.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author

open-service-broker-api@googlegroups.com