Skip to content

docs: improve for CloudEvents #475

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

Merged
merged 1 commit into from
Dec 16, 2024
Merged

docs: improve for CloudEvents #475

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
This directory contains advanced docs around the Functions Framework.

- [Testing events and Pub/Sub](events.md)
- [Testing CloudEvents](cloudevents.md)
- [Testing Functions](testing-functions.md)
- [Debugging Functions](debugging.md)
- [Running and Deploying Docker Containers](docker.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/cloudevents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Add a `package.json` script to start the Functions Framework and pass the name o
```sh
{
"scripts": {
"start": "functions-framework --target=helloCloudEvents"
"start": "functions-framework --target=helloCloudEvents --signature-type=cloudevent"
}
}
```
Expand All @@ -51,5 +51,5 @@ it is no longer accessible via `HTTP GET` requests from the browser.
### Create and Send a CloudEvent to the Function

```
cloudevents send http://localhost:8080 --specver--id abc-123 --source cloudevents.conformance.tool --type foo.bar
```
cloudevents send http://localhost:8080 --id abc-123 --source cloudevents.conformance.tool --type foo.bar
```