3 releases (breaking)

new 0.3.0	May 4, 2025
0.2.1	Jul 4, 2024
0.1.0	Aug 11, 2022

#1 in #alarm

134 downloads per month

Apache-2.0

99KB
2K SLoC

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

Author

tech@p7m.de

Dependencies

~8–20MB
~277K SLoC