Rust API client for tapis-notifications
The Tapis Notifications API provides for management of subscriptions and event publication
For more information, please visit https://tapis-project.org
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: 25Q4.0
- Package version: 0.2.0
- Generator version: 7.18.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named tapis-notifications and add the following to Cargo.toml under [dependencies]:
tapis-notifications = { path = "./tapis-notifications" }
Documentation for API Endpoints
All URIs are relative to http://localhost:8080
| Class | Method | HTTP request | Description |
|---|---|---|---|
| EventsApi | end_event_series | POST /v3/notifications/events/endSeries | |
| EventsApi | post_event | POST /v3/notifications/events | |
| EventsApi | publish_event | POST /v3/notifications/events/publish | |
| GeneralApi | health_check | GET /v3/notifications/healthcheck | |
| GeneralApi | ready_check | GET /v3/notifications/readycheck | |
| SubscriptionsApi | delete_subscription_by_name | DELETE /v3/notifications/subscriptions/byName/{name} | |
| SubscriptionsApi | delete_subscription_by_uuid | DELETE /v3/notifications/subscriptions/byUuid/{uuid} | |
| SubscriptionsApi | delete_subscriptions_by_subject | DELETE /v3/notifications/subscriptions/bySubject/{subject} | |
| SubscriptionsApi | disable_subscription | POST /v3/notifications/subscriptions/{name}/disable | |
| SubscriptionsApi | enable_subscription | POST /v3/notifications/subscriptions/{name}/enable | |
| SubscriptionsApi | get_subscription_by_name | GET /v3/notifications/subscriptions/byName/{name} | |
| SubscriptionsApi | get_subscription_by_uuid | GET /v3/notifications/subscriptions/byUuid/{uuid} | |
| SubscriptionsApi | get_subscriptions | GET /v3/notifications/subscriptions | |
| SubscriptionsApi | is_enabled | GET /v3/notifications/subscriptions/{name}/isEnabled | |
| SubscriptionsApi | patch_subscription_by_name | PATCH /v3/notifications/subscriptions/byName/{name} | |
| SubscriptionsApi | post_subscription | POST /v3/notifications/subscriptions | |
| SubscriptionsApi | search_subscriptions_query_parameters | GET /v3/notifications/subscriptions/search | |
| SubscriptionsApi | search_subscriptions_request_body | POST /v3/notifications/subscriptions/search | |
| SubscriptionsApi | update_ttl | POST /v3/notifications/subscriptions/{name}/updateTTL/{ttlMinutes} | |
| TestApi | begin_test_sequence | POST /v3/notifications/test/begin | |
| TestApi | delete_test_sequence | DELETE /v3/notifications/test/{name} | |
| TestApi | get_test_sequence | GET /v3/notifications/test/{name} | |
| TestApi | record_test_notification | POST /v3/notifications/test/callback/{name} |
Documentation For Models
- DeliveryMethod
- DeliveryTarget
- Event
- EventSeries
- Notification
- ReqPatchSubscription
- ReqPostSubscription
- ReqSearchSubscriptions
- RespBasic
- RespBoolean
- RespChangeCount
- RespNameArray
- RespResourceUrl
- RespSubscription
- RespSubscriptions
- RespSubscriptionsMetadata
- RespTestSequence
- ResultBoolean
- ResultChangeCount
- ResultNameArray
- ResultResourceUrl
- TapisSubscription
- TestSequence
To get access to the crate's generated documentation, use:
cargo doc --open