Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: change title #3

Merged
merged 1 commit into from
Feb 7, 2024
Merged

README: change title #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
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
Loading