[−][src]Trait splinter::rest_api::RestResourceProvider

pub trait RestResourceProvider {
    fn resources(&self) -> Vec<Resource>;
}

A RestResourceProvider provides a list of resources that are consumed by RestApi.

Required methods

fn resources(&self) -> Vec<Resource>

Loading content...

Implementors

impl RestResourceProvider for AdminService[src]

The admin service provides the following endpoints as REST API resources:

  • GET /ws/admin/register/{type} - Register as an application authorization handler for the given circuit management type
  • POST /admin/submit - Submit a circuit management payload
  • GET /admin/proposals - List circuit proposals in Splinter's state
  • GET /admin/proposals/{circuit_id} - Fetch a specific circuit proposal in Splinter's state by circuit ID

These endpoints are only available if the following REST API backend feature is enabled:

  • rest-api-actix

impl RestResourceProvider for BiomeRestResourceManager[src]

impl RestResourceProvider for ServiceOrchestrator[src]

The ServiceOrchestrator exposes REST API resources provided by the ServiceFactory::get_rest_endpoints methods of its factories. Each factory defines the endpoints provided by the services it creates; the ServiceOrchestrator then exposes these endpoints under the /{service_type}/{circuit}/{service_id} route.

impl RestResourceProvider for dyn RwRegistry[src]

The RwRegistry trait service provides the following endpoints as REST API resources:

  • GET /registry/nodes - List the nodes in the registry
  • POST /registry/nodes - Add a node to the registry
  • GET /registry/nodes/{identity} - Fetch a specific node in the registry
  • PUT /registry/nodes/{identity} - Replace a node in the registry
  • DELETE /registry/nodes/{identity} - Delete a node from the registry

These endpoints are only available if the following REST API backend feature is enabled:

  • rest-api-actix

impl<T: CircuitStore + 'static> RestResourceProvider for CircuitResourceProvider<T>[src]

The circuit store provides the following endpoints as REST API resources:

  • GET /admin/circuits - List circuits in Splinter's state
  • GET /admin/circuits/{circuit_id} - Fetch a specific circuit in Splinter's state by circuit ID

These endpoints are only available if the following REST API backend feature is enabled:

  • rest-api-actix
Loading content...