Skip to content

Commit

Permalink
README: change title
Browse files Browse the repository at this point in the history
Signed-off-by: Achille Roussel <achille.roussel@gmail.com>
  • Loading branch information
achille-roussel committed Feb 7, 2024
1 parent e9dbb14 commit dd0520d
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
[![MIT License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE)
[![Docs](https://img.shields.io/badge/API-reference-lightblue.svg)](https://buf.build/stealthrocket/dispatch-sdk/docs/main:dispatch.sdk.v1)

# Dispatch API
# Dispatch SDK

This module contains the protobuf definitions for the Dispatch API.
This module contains the protobuf definitions for the Dispatch SDK.

[connectrpc]: https://connectrpc.com/
[grpc]: https://grpc.io/
Expand All @@ -25,8 +25,8 @@ generate [connectrpc][connectrpc] or [gRPC][grpc] clients and servers.

## Authentication

To authenticate with the Dispatch API, a client must present a valid API key
in the `Authorization` header of the HTTP requests, for example:
To authenticate with the Dispatch control plane, a client must present a valid
API key in the `Authorization` header of the HTTP requests, for example:

```sh
curl https://api.stealthrocket.cloud/dispatch.sdk.v1.DispatchRequest/Dispatch \
Expand All @@ -51,8 +51,7 @@ Function endpoints are implemented by exposing the
[`dispatch.sdk.v1.FunctionService/Run`][rpc-function]
method on a [connectrpc][connectrpc] or [gRPC][grpc] endpoint.

The scheduler will make the function calls that were submitted via the Dispatch
API.
The scheduler will make the function calls that were submitted via the API.

### Verification of Function Calls

Expand Down

0 comments on commit dd0520d

Please sign in to comment.