p7m-alarm
| Crates.io | p7m-alarm |
| lib.rs | p7m-alarm |
| version | |
| source | src |
| created_at | 2022-08-11 01:52:58.0311+00 |
| updated_at | 2025-05-04 10:15:10.805692+00 |
| description | ## API for generating and tracking alarms This is the API of what P7M mainly uses within the Telfas service. |
| homepage | |
| repository | https://github.com/projekt7m/alarm-rust |
| max_upload_size | |
| id | 643027 |
| Cargo.toml error: | TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
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.3.0
- Package version: 0.3.0
- Generator version: 7.13.0-SNAPSHOT
- 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/{alarm_id} | Delete an alarm by its ID AlarmApi | delete_alarms_recipients_id | DELETE /alarms/{alarm_id}/recipients/{alarm_recipient_id} | Delete a single alarm recipient by its ID AlarmApi | get_alarms | GET /alarms | Get a list of all alarms AlarmApi | get_alarms_id | GET /alarms/{alarm_id} | Get a single alarm by its ID AlarmApi | get_alarms_recipients | GET /alarms/{alarm_id}/recipients | Get the list of receipients of an alarm AlarmApi | get_alarms_recipients_id | GET /alarms/{alarm_id}/recipients/{alarm_recipient_id} | Get a single recipient of an alarm by its ID AlarmApi | post_alarm | POST /alarms | Create a new alarm and by that trigger signalling AlarmApi | post_alarm_recipients | POST /alarms/{alarm_id}/recipients | Add a new recipient to an existing alarm AlarmApi | put_alarms_id | PUT /alarms/{alarm_id} | Update an existing alarm AlarmApi | put_alarms_recipients_id | PUT /alarms/{alarm_id}/recipients/{alarm_recipient_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 RecipientApi | delete_recipients_recipient_id | DELETE /recipients/{recipient_id} | Delete a single recipient by its ID RecipientApi | get_recipients | GET /recipients | Get the list of all recipients RecipientApi | get_recipients_recipient_id | GET /recipients/{recipient_id} | Get a single recipient by its ID RecipientApi | post_recipients | POST /recipients | Create a new recipient RecipientApi | put_recipients_recipient_id | PUT /recipients/{recipient_id} | Update an existing recipient
Documentation For Models
To get access to the crate's generated documentation, use:
cargo doc --open