diff options
| author | David Mehren | 2020-11-15 21:02:36 +0100 |
|---|---|---|
| committer | GitHub | 2020-11-15 21:02:36 +0100 |
| commit | 4c0efe1237bc33b52d06eaf86a28adad9a041ec2 (patch) | |
| tree | fa068d16074645b7b6d8d88b78724b9cd82dd879 /docs/dev/api.md | |
| parent | 299301f0fe5bea41b4407bbbc03932fc4dd1c1d3 (diff) | |
| parent | 9898ab3ca5fa226967d8a3aca8e6e752554ed64d (diff) | |
Merge pull request #453 from hedgedoc/misc/renaming
Diffstat (limited to '')
| -rw-r--r-- | docs/dev/api.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/dev/api.md b/docs/dev/api.md index fbbdae83..5422533d 100644 --- a/docs/dev/api.md +++ b/docs/dev/api.md @@ -1,5 +1,5 @@ # API documentation -Several tasks of CodiMD can be automated through HTTP requests. +Several tasks of HedgeDoc can be automated through HTTP requests. The available endpoints for this api are described in this document. For code-autogeneration there is an OpenAPIv3-compatible description available [here](openapi.yml). @@ -34,9 +34,9 @@ These endpoints return information about the current logged-in user and it's not | `/history/<NOTE>` | `POST` | **Toggles the pinned status in the history for a note.**<br>The body must be form-encoded and contain a field `pinned` that is either `true` or `false`. | | `/history/<NOTE>` | `DELETE` | **Deletes a note from the user's history.** | -## CodiMD-server -These endpoints return information about the running CodiMD instance. +## HedgeDoc-server +These endpoints return information about the running HedgeDoc instance. | Endpoint | HTTP-Method | Description | | --------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `/status` | `GET` | **Returns the current status of the CodiMD instance.**<br>The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more. | +| `/status` | `GET` | **Returns the current status of the HedgeDoc instance.**<br>The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more. | |