Skip to content

Commit

Permalink
website: fix links in http page. (#1647)
Browse files Browse the repository at this point in the history
  • Loading branch information
thruflo authored Sep 9, 2024
1 parent ccc6f1d commit 0541cac
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 5 additions & 2 deletions website/docs/api/http.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
title: HTTP API
description: >-
The HTTP API is the primary, low level API for syncing data with Electric.
outline: deep
---

# HTTP API

The HTTP API is the primary, low level API for syncing data with Electric Next.
The HTTP API is the primary, low level API for syncing data with Electric.

Normative API documentation is published as an [OpenAPI](https://www.openapis.org/what-is-openapi) specification:

- [download the specification file](https://github.com/electric-sql/electric/blob/main/docs/electric-api.yaml) to view or use with other OpenAPI [tooling](https://tools.openapis.org/)
- [download the specification file](https://github.com/electric-sql/electric/blob/main/website/electric-api.yaml) to view or use with other OpenAPI [tooling](https://tools.openapis.org/)
- <a href="/openapi.html" target="_blank">view the HTML documentation</a> generated using [Redocly](https://redocly.com)

The rest of this page will describe the features of the API.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ mkdir my-first-electric
cd my-first-electric
```

Run a fresh Postgres and Electric using this [docker-compose.yaml](https://github.com/electric-sql/electric/blob/main/docs/public/docker-compose.yaml) file:
Run a fresh Postgres and Electric using this [docker-compose.yaml](https://github.com/electric-sql/electric/blob/main/website/public/docker-compose.yaml) file:

```sh
curl -O https://electric-sql.com/docker-compose.yaml
Expand Down

0 comments on commit 0541cac

Please sign in to comment.