#client #provision #flags #information #service #bindings #osb #visit #removal #instance

bin+lib rocs

Rust OSB client

22 stable releases

1.0.21 May 17, 2022
1.0.19 Sep 3, 2021
1.0.18 Jul 7, 2021
1.0.16 Jul 15, 2020
1.0.4 Mar 19, 2020

MIT license

42KB
964 lines

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

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

Usage

rocs 0.1
Rodrigo Vaz
Rust OSB Client 'Super'

USAGE:
    rocs [FLAGS] --password <broker_pass> --broker <broker_url> --username <broker_user> <SUBCOMMAND>

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

OPTIONS:
    -a, --password <broker_pass>     [env: ROCS_BROKER_PASSWORD=]
    -b, --broker <broker_url>        [env: ROCS_BROKER_URL=]
    -u, --username <broker_user>     [env: ROCS_BROKER_USERNAME=]

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 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

~43MB
~876K SLoC