Skip to content

lab5e/rust-spanapi

Repository files navigation

Rust API client for spanapi

API for device, collection, output and firmware management

For more information, please visit https://lab5e.com

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: 5.0.3 pitch-dark-elza
  • Package version: 5.0.3
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named spanapi and add the following to Cargo.toml under [dependencies]:

spanapi = { path = "./spanapi" }

Documentation for API Endpoints

All URIs are relative to https://api.lab5e.com

Class Method HTTP request Description
BlobsApi delete_blob DELETE /span/collections/{collectionId}/blobs/{blobId} Remove a blob stored on a collection
BlobsApi list_blobs GET /span/collections/{collectionId}/blobs List the blobs for a collection
CertificatesApi create_certificate POST /span/collections/{collectionId}/certificates/create Create certificate
CertificatesApi retrieve_certificate_chain GET /span/collections/{collectionId}/certificates Get certificate chain
CertificatesApi sign_certificate POST /span/collections/{collectionId}/certificates/sign Sign certificate
CertificatesApi verify_certificate POST /span/collections/{collectionId}/certificates/verify Verify certificate
CollectionsApi create_collection POST /span/collections Create collection
CollectionsApi delete_collection DELETE /span/collections/{collectionId} Delete collection
CollectionsApi list_collection_data GET /span/collections/{collectionId}/data Retrieve data from devices
CollectionsApi list_collections GET /span/collections List collections
CollectionsApi retrieve_collection GET /span/collections/{collectionId} Retrieve collection
CollectionsApi retrieve_collection_stats GET /span/collections/{collectionId}/stats Retrieve collection statistics
CollectionsApi update_collection PATCH /span/collections/{collectionId} Update collection
DevicesApi add_downstream_message POST /span/collections/{collectionId}/devices/{deviceId}/outbox Add message to oubox
DevicesApi create_device POST /span/collections/{collectionId}/devices Create device
DevicesApi delete_device DELETE /span/collections/{collectionId}/devices/{deviceId} Remove device.
DevicesApi delete_downstream_message DELETE /span/collections/{collectionId}/devices/{deviceId}/outbox/{messageId} Delete outgoing message
DevicesApi device_certificate GET /span/collections/{collectionId}/devices/{deviceId}/certs Get issued certificate(s) for device
DevicesApi list_device_data GET /span/collections/{collectionId}/devices/{deviceId}/data Retrieve data from device
DevicesApi list_devices GET /span/collections/{collectionId}/devices List devices in collection.
DevicesApi list_downstream_messages GET /span/collections/{collectionId}/devices/{deviceId}/outbox List the messages in the outbox
DevicesApi list_upstream_messages GET /span/collections/{collectionId}/devices/{deviceId}/inbox List incoming messages
DevicesApi retrieve_device GET /span/collections/{collectionId}/devices/{deviceId} Retrieve device
DevicesApi retrieve_device_stats GET /span/collections/{collectionId}/devices/{deviceId}/stats Retrieve device statistics
DevicesApi update_device PATCH /span/collections/{existingCollectionId}/devices/{deviceId} Update device
FotaApi clear_firmware_error DELETE /span/collections/{collectionId}/devices/{deviceId}/fwerror Clear FOTA error
FotaApi create_firmware POST /span/collections/{collectionId}/firmware Create firmware
FotaApi delete_firmware DELETE /span/collections/{collectionId}/firmware/{imageId} Delete firmware
FotaApi firmware_usage GET /span/collections/{collectionId}/firmware/{imageId}/usage Firmware usage
FotaApi list_firmware GET /span/collections/{collectionId}/firmware List firmware
FotaApi retrieve_firmware GET /span/collections/{collectionId}/firmware/{imageId} Retrieve firmware
FotaApi retrieve_firmware_stats GET /span/collections/{collectionId}/firmware/{imageId}/stats Retrieve firmware statistics
FotaApi update_firmware PATCH /span/collections/{existingCollectionId}/firmware/{imageId} Update firmware
GatewaysApi create_gateway POST /span/collections/{collectionId}/gateways Create gateway
GatewaysApi delete_gateway DELETE /span/collections/{collectionId}/gateways/{gatewayId} Delete gateway
GatewaysApi gateway_certificates GET /span/collections/{collectionId}/gateways/{gatewayId}/certs Get issued certificate(s) for gateway
GatewaysApi list_gateways GET /span/collections/{collectionId}/gateways List gateways
GatewaysApi retrieve_gateway GET /span/collections/{collectionId}/gateways/{gatewayId} Retrieve gateway
GatewaysApi retrieve_gateway_stats GET /span/collections/{collectionId}/gateways/{gatewayId}/stats Retrieve gateway statistics
GatewaysApi update_gateway PATCH /span/collections/{existingCollectionId}/gateways/{gatewayId} Update gateway
OutputsApi create_output POST /span/collections/{collectionId}/outputs Create output
OutputsApi delete_output DELETE /span/collections/{collectionId}/outputs/{outputId} Delete output
OutputsApi list_outputs GET /span/collections/{collectionId}/outputs List outputs
OutputsApi logs GET /span/collections/{collectionId}/outputs/{outputId}/logs Output logs
OutputsApi retrieve_output GET /span/collections/{collectionId}/outputs/{outputId} Retrieve output
OutputsApi retrieve_output_stats GET /span/collections/{collectionId}/outputs/{outputId}/stats Retrieve output statistics
OutputsApi status GET /span/collections/{collectionId}/outputs/{outputId}/status Output status
OutputsApi update_output PATCH /span/collections/{existingCollectionId}/outputs/{outputId} Update output
SpanApi get_system_info GET /span/system System information

Documentation For Models

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

cargo doc --open

Author

dev@lab5e.com

About

Rust API client for the Span service

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages