From 266c84d625b72dae5ea7157b016f73aa7b2c6f83 Mon Sep 17 00:00:00 2001 From: Daniel R Holland <32673504+DanielRHolland@users.noreply.github.com> Date: Mon, 25 Mar 2024 11:31:52 -0400 Subject: docs: Update readme.md REST != HTTP "Ackchyually......." --- readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 4bb90b7..e53efdb 100644 --- a/readme.md +++ b/readme.md @@ -2,9 +2,9 @@ This is a comments component for adding to web pages, plus a backend service that stores comments in a database. -Users can delete their own comments, but the server does not save any user information. This is acheived by generating a key for every new comment, which is cached in the browser of the creator, and also stored in the server's database. Deletion REST requests must include this number, as well as the comment's id. +Users can delete their own comments, but the server does not save any user information. This is acheived by generating a key for every new comment, which is cached in the browser of the creator, and also stored in the server's database. Deletion HTTP requests must include this number, as well as the comment's id. -### Server REST API +### Server HTTP API - `GET /comments?page_id=add-page-id-here` : returns a json array of comments for the page 'add-page-id-here'. - `POST /comments` : takes a json body of the form `{"bot":"no", "content": "foo bar", "deletion_key": "3858516384593962266", "page_id":"add-page-id-here"}`. Creates a comment and returns plain text containing the id of the new comment. -- cgit v1.2.3