Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Danny Sheridan committed Oct 17, 2022
1 parent be6350a commit b91dadd
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# [TODO] API
# Hookdeck API

Tagging a release on this repository will:

- Update the [TypeScript SDK Github Repo](https://github.com/fern-api/TODO-node)
- Update the [TypeScript SDK Github Repo](https://github.com/fern-hookdeck/hookdeck-node)
- _More SDKs to come..._

## What is in this repository?

This repository contains

- TODO's Fern API Definition which lives in the [definition](./fern/api/definition/) folder
- Hookdeck's Fern API Definition which lives in the [definition](./fern/api/definition/) folder
- Generators (see [generators.yml](./fern/api/generators.yml))

## What is in the API Definition?

The API Definition contains information about what endpoints, types, and errors are used in the API. The definition is broken into smaller files such as [TODO.yml](fern/api/definition/TODO.yml) and [TODO.yml](fern/api/definition/TODO.yml).
The API Definition contains information about what endpoints, types, and errors are used in the API. The definition is broken into smaller files such as [connection.yml](fern/api/definition/connection.yml) and [event.yml](fern/api/definition/event.yml).

In order to make sure that the definition is valid, you can use the Fern CLI.

Expand Down
2 changes: 1 addition & 1 deletion fern/api/definition/bulkretry.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ services:
type: optional<BulkRetryId>
docs: ID of the bulk retry
query:
type: optional<string> #TODO consider changing to unknown
type: optional<string> # consider changing to unknown
docs: Filter filter for events to be included in the bulk retry, use query parameters of Event
query_partial_match:
type: optional<boolean>
Expand Down

0 comments on commit b91dadd

Please sign in to comment.