1 unstable release

0.1.0	Aug 11, 2022

#9 in #alarm

Apache-2.0

66KB
1K 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.

For most endpoints, the caller has to be authenticated with the system and provide a JWT token in the Authorization header of the HTTP request. If your interacting with this API using the Swagger interface, you need to set the JWT token by clicking on the Authorize button on the right side of the header. As the value don't forget that the Authorization header starts with the fixed value Bearer followed by a space followed by the actual JWT token value.

If anything is unclear or you found a bug in the documentation, please contact tech@p7m.de.

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.1.0
Package version: 0.1.0
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
AlarmApi	alarms_get	GET /alarms
AlarmApi	alarms_id_delete	DELETE /alarms/{id}
AlarmApi	alarms_id_get	GET /alarms/{id}
AlarmApi	alarms_id_put	PUT /alarms/{id}
AlarmApi	alarms_post	POST /alarms
AlarmRecipientApi	alarms_aid_recipients_get	GET /alarms/{aid}/recipients
AlarmRecipientApi	alarms_aid_recipients_id_delete	DELETE /alarms/{aid}/recipients/{id}
AlarmRecipientApi	alarms_aid_recipients_id_get	GET /alarms/{aid}/recipients/{id}
AlarmRecipientApi	alarms_aid_recipients_id_put	PUT /alarms/{aid}/recipients/{id}
AlarmRecipientApi	alarms_aid_recipients_post	POST /alarms/{aid}/recipients
AlarmTypeApi	alarmtypes_get	GET /alarmtypes
AlarmTypeApi	alarmtypes_id_delete	DELETE /alarmtypes/{id}
AlarmTypeApi	alarmtypes_id_get	GET /alarmtypes/{id}
AlarmTypeApi	alarmtypes_id_put	PUT /alarmtypes/{id}
AlarmTypeApi	alarmtypes_post	POST /alarmtypes

Documentation For Models

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

cargo doc --open

Author

Dependencies

~4–18MB
~259K SLoC