From b28839484d120c04c5a06e7f8318650c78ab195b Mon Sep 17 00:00:00 2001 From: Erik Michelson Date: Thu, 2 Jul 2020 17:22:52 +0200 Subject: Replace CodiMD with HedgeDoc Signed-off-by: Erik Michelson Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in public/views Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in README Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in SECURITY.md Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in LICENSE Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in docs/configuration.md Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in bin/setup Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/guides Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/dev Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/guides/auth Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/setup Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update various links in code to the new GitHub org. Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: codiMDVersion.js is now hedgeDocVersion.js Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/setup/yunohost Signed-off-by: Tilman Vatteroth Rebrand to HedgeDoc: Add banner and logo Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in docs/guides/migrate-etherpad Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Remove note in docs/guides/auth/github Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Replace links in public/docs/features Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Add todo placeholder in docs/history Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Replace github link in public/views/index/body Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Replace github link in README Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Add logo to README Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Add note about the renaming to the front page Signed-off-by: Tilman Vatteroth Removed Travis from README.md and change CodiMD to HedgeDoc in some places Signed-off-by: Yannick Bungers Some more renaming to HedgeDoc - Fixed capitalization of HedgeDoc - Added renaming for etherpad migration doc Signed-off-by: Yannick Bungers Changed Repo name to hedgedoc Signed-off-by: Yannick Bungers --- docs/dev/api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/dev/api.md') 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/` | `POST` | **Toggles the pinned status in the history for a note.**
The body must be form-encoded and contain a field `pinned` that is either `true` or `false`. | | `/history/` | `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.**
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.**
The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more. | -- cgit v1.2.3