From 63dfe86738826d65ce5238e585710a274969acbc Mon Sep 17 00:00:00 2001 From: Danial Raza Date: Thu, 18 Jan 2024 00:56:32 +0100 Subject: [PATCH] docs: consistency changes --- README.md | 6 +++--- docs/quotes/get-quote-by-id.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 88daea9..38c138b 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,15 @@ For detailed information on how to use each endpoint, refer to the corresponding - [Get Quote By Id](docs/quotes/get-quote-by-id.md) - [Get all the quotes by an author](docs/quotes/get-quotes-by-author.md) - [Get all the quotes in a category](docs/quotes/get-quotes-in-category.md) -- [Create a quote](#create-quote) +- [Create a quote](docs/quotes/create-quote) ## Quote Structure | Field | Type | Description | | ---------- | ----------------- | ----------------------------------- | | id | integer | The id of the quote | -| created_at | ISO8601 timestamp | When the quote was submitted | -| updated_at | ISO8601 timestamp | When the quote was last updated | +| created_at | ISO8601 timestamp | The date the quote was submitted | +| updated_at | ISO8601 timestamp | The date the quote was last updated | | author | string | The author of the quote | | categories | array of string | The categories the quote belongs in | | submitter | string | The submitter of the quote | diff --git a/docs/quotes/get-quote-by-id.md b/docs/quotes/get-quote-by-id.md index 4020238..20e8e2d 100644 --- a/docs/quotes/get-quote-by-id.md +++ b/docs/quotes/get-quote-by-id.md @@ -10,7 +10,7 @@ GET /quotes/:id ## Parameters -- **id** - The Id of the quote. +- **id** - The id of the quote. ### Example Response