p7m-alarm

Crates.iop7m-alarm
lib.rsp7m-alarm
version0.2.1
sourcesrc
created_at2022-08-11 01:52:58.0311
updated_at2024-07-04 23:36:28.251158
descriptionRust bindings for the alarm API of P7M
homepage
repositoryhttps://github.com/projekt7m/alarm-rust
max_upload_size
id643027
size77,916
Matthias Wimmer (mawis)

documentation

README

Rust API client for p7m-alarm

API for generating and tracking alarms

This is the API of what P7M mainly uses within the Telfas service.

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

Installation

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

p7m-alarm = { path = "./p7m-alarm" }

Documentation for API Endpoints

All URIs are relative to https://alarm.api.p7m.de/v1

Class Method HTTP request Description

AlarmApi | delete_alarms_id | DELETE /alarms/{id} | Delete an alarm by its ID AlarmApi | get_alarms | GET /alarms | Get a list of all alarms AlarmApi | get_alarms_id | GET /alarms/{id} | Get a single alarm by its ID AlarmApi | post_alarm | POST /alarms | Create a new alarm and by that trigger signalling AlarmApi | put_alarms_id | PUT /alarms/{id} | Update an existing alarm AlarmRecipientApi | delete_alarms_recipients_id | DELETE /alarms/{aid}/recipients/{id} | Delete a single alarm recipient by its ID AlarmRecipientApi | get_alarms_recipients | GET /alarms/{aid}/recipients | Get the list of receipients of an alarm AlarmRecipientApi | get_alarms_recipients_id | GET /alarms/{aid}/recipients/{id} | Get a single recipient of an alarm by its ID AlarmRecipientApi | post_alarm_recipients | POST /alarms/{aid}/recipients | Add a new recipient to an existing alarm AlarmRecipientApi | put_alarms_recipients_id | PUT /alarms/{aid}/recipients/{id} | Update an existing recipient of an alarm AlarmTypeApi | delete_alarm_types | DELETE /alarmtypes/{id} | Delete a single alarm type by its ID AlarmTypeApi | get_alarm_types | GET /alarmtypes | Get list of all alarm types AlarmTypeApi | get_alarm_types_id | GET /alarmtypes/{id} | Get a single alarm type by its ID AlarmTypeApi | post_alarm_types | POST /alarmtypes | Create a new alarm type AlarmTypeApi | put_alarm_types | PUT /alarmtypes/{id} | Update an existing alarm type

Documentation For Models

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

cargo doc --open

Author

tech@p7m.de

Commit count: 4

cargo fmt