Skip to content

Commit

Permalink
Chore: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
das-Abroxas committed Jul 15, 2024
1 parent 92c3abb commit 7f407df
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Aruna API Definitions
# Aruna - API Definitions

This repo contains the definitions of the Aruna API. It is written in the [protocol-buffers](https://developers.google.com/protocol-buffers) interface definition language (IDL). This can be used to automatically generate clients in many different programming languages using the [gRPC](https://grpc.io/docs/what-is-grpc/introduction/) framework.

Expand All @@ -22,7 +22,7 @@ The API contains three main sections:

- [Notification section](#notifications): This section contains a set of services and models that describe the interfaces with the notification system.

- [Hooks section](#internal): This section contains the service that can be used to extend Aruna with external functionality or automate internal processes.
- [Hooks section](#hooks): This section contains the service that can be used to extend Aruna with external functionality or automate internal processes.


### Storage
Expand All @@ -36,12 +36,12 @@ The storage section is divided in two subsections:

### Notifications

The Notification section provides a set of RPCs that are used to interact with the notification system. The notification system uses [nats.io](https://nats.io/) as its underlying service. The service definition can be found [here](notifications/services/v2/notification_service.proto).
The Notification section provides a set of RPCs that are used to interact with the notification system. The notification system uses [nats.io](https://nats.io/) as its underlying service. The service definition can be found [here](aruna/api/notification/services/v2/notification_service.proto).


### Hooks

Hooks are the way to automate internal processes in Aruna and/or to integrate external services to extend functionality. Once created, they're available globally in Aruna, and Projects must be associated with them to be included in their trigger cycle. The action that triggers the specific hook is defined by its trigger type.
Hooks are the way to automate internal processes in Aruna and/or to integrate external services to extend functionality. Once created, they're available globally in Aruna, and Projects must be associated with them to be included in their trigger cycle. The action that triggers the specific hook is defined by its trigger type. The service definition can be found [here](aruna/api/hooks/services/v2/hooks_service.proto).


## License
Expand Down

0 comments on commit 7f407df

Please sign in to comment.