#api-service #api-client #open-api #platform #generated #api-version #generator

rocl

Rust OSB client library used by rocs generated with openapi-generator

6 releases

0.0.7 Jun 29, 2021
0.0.5 Jul 10, 2020
0.0.4 Apr 17, 2020

#1779 in Web programming


Used in rocs

MIT license

74KB
1K SLoC

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 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.RustClientCodegen For more information, please visit 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 get /v2/catalog get the catalog of services that the service broker offers
ServiceBindingsApi service_binding_binding put /v2/service_instances/{instance_id}/service_bindings/{binding_id} generate a service binding
ServiceBindingsApi service_binding_get get /v2/service_instances/{instance_id}/service_bindings/{binding_id} get a service binding
ServiceBindingsApi 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 delete /v2/service_instances/{instance_id}/service_bindings/{binding_id} deprovision a service binding
ServiceInstancesApi service_instance_deprovision delete /v2/service_instances/{instance_id} deprovision a service instance
ServiceInstancesApi service_instance_get get /v2/service_instances/{instance_id} get a service instance
ServiceInstancesApi 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 put /v2/service_instances/{instance_id} provision a service instance
ServiceInstancesApi service_instance_update patch /v2/service_instances/{instance_id} update a service instance

Documentation For Models

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

cargo doc --open

Author

open-service-broker-api@googlegroups.com

Dependencies

~4–18MB
~260K SLoC