Rust API client for openapi

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

Overview

For more information, please visit https://www.openservicebrokerapi.org/

Installation

Using cargo

cargo install rocs

Manually

SHELL git clone https://github.com/rsampaio/rocs.git && cd rocs cargo install

Usage

```SHELL rocs 0.1 Rodrigo Vaz Rust OSB Client 'Super'

USAGE: rocs [FLAGS] --password --broker --username

FLAGS: -h, --help Prints help information --json Prints result in JSON format -V, --version Prints version information

OPTIONS: -a, --password [env: ROCSBROKERPASSWORD=] -b, --broker [env: ROCSBROKERURL=] -u, --username [env: ROCSBROKERUSERNAME=]

SUBCOMMANDS: bind Service Binding request catalog Catalog request credentials Binding credentials deprovision Service Instance deprovisioning help Prints this message or the help of the given subcommand(s) provision Service Instance provisioning unbind Service Binding removal

```

Documentation for API Endpoints

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

| Class | Method | HTTP request | Description | | --------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------- | | CatalogApi | catalogget | get /v2/catalog | get the catalog of services that the service broker offers | | *ServiceBindingsApi* | servicebindingbinding | put /v2/serviceinstances/{instanceid}/servicebindings/{bindingid} | generate a service binding | | *ServiceBindingsApi* | servicebindingget | get /v2/serviceinstances/{instanceid}/servicebindings/{bindingid} | get a service binding | | *ServiceBindingsApi* | servicebindinglastoperationget | get /v2/serviceinstances/{instanceid}/servicebindings/{bindingid}/lastoperation | get the last requested operation state for service binding | | ServiceBindingsApi | servicebindingunbinding | delete /v2/serviceinstances/{instanceid}/servicebindings/{bindingid} | deprovision a service binding | | ServiceInstancesApi | serviceinstancedeprovision | delete /v2/serviceinstances/{instanceid} | deprovision a service instance | | ServiceInstancesApi | serviceinstanceget | get /v2/serviceinstances/{instanceid} | get a service instance | | ServiceInstancesApi | serviceinstancelastoperationget | get /v2/serviceinstances/{instanceid}/lastoperation | get the last requested operation state for service instance | | *ServiceInstancesApi* | serviceinstanceprovision | put /v2/serviceinstances/{instanceid} | provision a service instance | | *ServiceInstancesApi* | serviceinstanceupdate | patch /v2/serviceinstances/{instance_id} | update a service instance |

Documentation For Models

• AsyncOperation
• Catalog
• DashboardClient
• Error
• JsonSchema
• LastOperationResource
• MaintenanceInfo
• Plan
• PositiveIntegerDefault0
• Schema
• SchemaParameters
• Schemas
• Service
• ServiceBindingEndpoint
• ServiceBindingRequest
• ServiceBindingResouceObject
• ServiceBindingResource
• ServiceBindingResponse
• ServiceBindingSchema
• ServiceBindingVolumeMount
• ServiceBindingVolumeMountDevice
• ServiceInstanceAsyncOperation
• ServiceInstancePreviousValues
• ServiceInstanceProvisionRequest
• ServiceInstanceProvisionResponse
• ServiceInstanceResource
• ServiceInstanceSchema
• ServiceInstanceUpdateRequest

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

cargo doc --open

Author

open-service-broker-api@googlegroups.com