From dbb7b1716ae8ae42946435bcd70e94df55f11346 Mon Sep 17 00:00:00 2001 From: Khushbu Borole Date: Mon, 8 Jun 2026 11:10:19 +0530 Subject: [PATCH 1/8] Added Collections reference docs Added get collections and get collections by ID --- docs/articles/Resources.md | 37 +++++++++ docs/articles/get-all-collection.md | 106 ++++++++++++++++++++++++++ docs/articles/get-collection-by-id.md | 85 +++++++++++++++++++++ docs/index.md | 16 ++-- 4 files changed, 237 insertions(+), 7 deletions(-) create mode 100644 docs/articles/Resources.md create mode 100644 docs/articles/get-all-collection.md create mode 100644 docs/articles/get-collection-by-id.md diff --git a/docs/articles/Resources.md b/docs/articles/Resources.md new file mode 100644 index 0000000..7edf481 --- /dev/null +++ b/docs/articles/Resources.md @@ -0,0 +1,37 @@ +--- +# markdownlint-disable +# vale off +# tags used by just-the-docs theme +layout: default +nav_order: 1 +has_children: true +has_toc: false +# tags used by AI files +description: Lists the reference articles available in the documentation +topic_type: overview +tags: + - introduction +categories: + - tutorial +ai_relevance: high +importance: 8 +prerequisites: [] +related_pages: + - /get-all-collection + - /get-all-collection-by-id +examples: [] +api_endpoints: [] +version: "v1.0" +last_updated: "2026-03-01" +# vale on +# markdownlint-enable +--- + + + +# Resources + +These resource reference articles are available to help you start using the **Keepit Service API**. + +* [Get all collections](get-all-collection.md) +* [Get collections by ID](get-collection-by-id.md) diff --git a/docs/articles/get-all-collection.md b/docs/articles/get-all-collection.md new file mode 100644 index 0000000..900559f --- /dev/null +++ b/docs/articles/get-all-collection.md @@ -0,0 +1,106 @@ +--- +# markdownlint-disable +# vale off +# tags used by just-the-docs theme +layout: default +parent: Resources +nav_order: 1 +# tags used by AI files +description: GET all `collections` resources from the service +topic_type: reference +ai_relevance: high +importance: 7 +api_endpoints: /collections +version: "v1.0" +last_updated: "2026-03-01" +# vale on +# markdownlint-enable +--- + + + +# Get all collections + +Returns all the collections archived with the service. + +## Endpoint + +```shell +{base_url}/collections +``` + +## Parameters + +None + +## Request headers + +None + +## Request body + +None + +## Response body + +```json +[ + { + "id": 1, + "name": "Austin Photographs", + "description": "Historical and contemporary photographs of Austin, Texas.", + "location": "Server A, Folder /austin-photos/", + "itemCount": 18 + } +] +``` + +## Examples + +### `GET` example request + +```bash +curl http://localhost:3000/collections +``` + +#### `GET` example response + +```json +[ + { + "id": 1, + "name": "Austin Photographs", + "description": "Historical and contemporary photographs of Austin, Texas.", + "location": "Server A, Folder /austin-photos/", + "itemCount": 18 + }, + { + "id": 2, + "name": "Austin Photographs", + "description": "Historical maps of Austin and surrounding areas.", + "location": "Server A, Folder /austin-maps/", + "itemCount": 12 + }, + { + "id": 3, + "name": "Texas Newspapers", + "description": "Digitized issues of historical Texas newspapers.", + "location": "Server B, Folder /tx-newspapers/", + "itemCount": 34 + }, + { + "id": 4, + "name": "Texas Oral Histories", + "description": "Audio recordings of interviews with Texas residents.", + "location": "Server C, Folder /tx-oral-histories/", + "itemCount": 22 + } +]% +``` + +## Response status + +| HTTP status value | Description | +| ------------- | ----------- | +| 200 | **Success:** Requested data returned successfully | +| ECONNREFUSED | Service is offline. Start, or restart the service and try again. | \ No newline at end of file diff --git a/docs/articles/get-collection-by-id.md b/docs/articles/get-collection-by-id.md new file mode 100644 index 0000000..49c5acc --- /dev/null +++ b/docs/articles/get-collection-by-id.md @@ -0,0 +1,85 @@ +--- +# markdownlint-disable +# vale off +# tags used by just-the-docs theme +layout: default +parent: Resources +nav_order: 2 +# tags used by AI files +description: GET all `collections` resources from the service +topic_type: reference +ai_relevance: high +importance: 7 +api_endpoints: /collections +version: "v1.0" +last_updated: "2026-03-01" +# vale on +# markdownlint-enable +--- + + + +# Get collections by ID + +Returns a archived collections by ID with the service. + +## Endpoint + +```shell +{base_url}/collections/{id} +``` + +## Parameters + +- id - ID of the collection you want to fetch from the Keepit service. + +## Request headers + +None + +## Request body + +None + +## Response body + +```json +[ + { + "id": 1, + "name": "Austin Photographs", + "description": "Historical and contemporary photographs of Austin, Texas.", + "location": "Server A, Folder /austin-photos/", + "itemCount": 18 + } +] +``` + +## Examples + +### `GET` example request + +```bash +curl http://localhost:3000/collections/4 +``` + +#### `GET` example response + +```json +[ + { + "id": 4, + "name": "Texas Oral Histories", + "description": "Audio recordings of interviews with Texas residents.", + "location": "Server C, Folder /tx-oral-histories/", + "itemCount": 22 + } +]% +``` + +## Response status + +| HTTP status value | Description | +| ------------- | ----------- | +| 200 | **Success:** Requested data returned successfully | +| ECONNREFUSED | Service is offline. Start, or restart the service and try again. | \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 83ca950..15e629c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,4 @@ + # KeepIT API ## Archive it. Find it. Keep it. @@ -22,19 +23,20 @@ Use this API to manage your digital archive - organize collections, add items, a ### Collections -- Get all collections — `GET /collections` -- Get a collection by ID — `GET /collections/{id}` -- Create a collection — `POST /collections` +- Get all collections - `GET /collections` +- Get collections by ID - `GET /collections/{id}` +- Create a collection - `POST /collections` ### Items -- Get all items — `GET /items` -- Get an item by ID — `GET /items/{id}` -- Create an item — `POST /items` +- Get all items - `GET /items` +- Get an item by ID - `GET /items/{id}` +- Create an item - `POST /items` ## Learn more -- [Collections resource](#) +* [Get all collections](get-all-collection.md) +* [Get collections by ID](get-collection-by-id.md) ## References From 44c5d1f8fc21e59eda1e71453cfbbdd16f4d94ea Mon Sep 17 00:00:00 2001 From: Khushbu Borole Date: Mon, 8 Jun 2026 11:17:16 +0530 Subject: [PATCH 2/8] Corrections --- docs/articles/Resources.md | 4 ++-- docs/articles/get-all-collection.md | 2 +- docs/articles/get-collection-by-id.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/articles/Resources.md b/docs/articles/Resources.md index 7edf481..17d161f 100644 --- a/docs/articles/Resources.md +++ b/docs/articles/Resources.md @@ -5,7 +5,7 @@ layout: default nav_order: 1 has_children: true -has_toc: false +has_toc: true # tags used by AI files description: Lists the reference articles available in the documentation topic_type: overview @@ -18,7 +18,7 @@ importance: 8 prerequisites: [] related_pages: - /get-all-collection - - /get-all-collection-by-id + - /get-collection-by-id examples: [] api_endpoints: [] version: "v1.0" diff --git a/docs/articles/get-all-collection.md b/docs/articles/get-all-collection.md index 900559f..77b24bc 100644 --- a/docs/articles/get-all-collection.md +++ b/docs/articles/get-all-collection.md @@ -95,7 +95,7 @@ curl http://localhost:3000/collections "location": "Server C, Folder /tx-oral-histories/", "itemCount": 22 } -]% +] ``` ## Response status diff --git a/docs/articles/get-collection-by-id.md b/docs/articles/get-collection-by-id.md index 49c5acc..fb759b9 100644 --- a/docs/articles/get-collection-by-id.md +++ b/docs/articles/get-collection-by-id.md @@ -74,7 +74,7 @@ curl http://localhost:3000/collections/4 "location": "Server C, Folder /tx-oral-histories/", "itemCount": 22 } -]% +] ``` ## Response status From ae1fa935e175ccff3c29f64daf31e109da2ebdf8 Mon Sep 17 00:00:00 2001 From: Khushbu Borole Date: Mon, 8 Jun 2026 11:25:48 +0530 Subject: [PATCH 3/8] Fixing Navigation --- docs/_config.yml | 1 + docs/articles/Resources.md | 4 +++- docs/articles/get-all-collection.md | 1 + docs/articles/get-collection-by-id.md | 1 + 4 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index 74a3ae4..eceec80 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,2 @@ title: To-Do service API +remote_theme: just-the-docs/just-the-docs \ No newline at end of file diff --git a/docs/articles/Resources.md b/docs/articles/Resources.md index 17d161f..f449eb6 100644 --- a/docs/articles/Resources.md +++ b/docs/articles/Resources.md @@ -3,7 +3,9 @@ # vale off # tags used by just-the-docs theme layout: default -nav_order: 1 +title: Resources +parent: KeepIT API +nav_order: 2 has_children: true has_toc: true # tags used by AI files diff --git a/docs/articles/get-all-collection.md b/docs/articles/get-all-collection.md index 77b24bc..6d8b86a 100644 --- a/docs/articles/get-all-collection.md +++ b/docs/articles/get-all-collection.md @@ -4,6 +4,7 @@ # tags used by just-the-docs theme layout: default parent: Resources +grand_parent: KeepIT API nav_order: 1 # tags used by AI files description: GET all `collections` resources from the service diff --git a/docs/articles/get-collection-by-id.md b/docs/articles/get-collection-by-id.md index fb759b9..330305a 100644 --- a/docs/articles/get-collection-by-id.md +++ b/docs/articles/get-collection-by-id.md @@ -4,6 +4,7 @@ # tags used by just-the-docs theme layout: default parent: Resources +grand_parent: KeepIT API nav_order: 2 # tags used by AI files description: GET all `collections` resources from the service From b867a707a5460becbaf2753880ed8ad2e24490a4 Mon Sep 17 00:00:00 2001 From: Khushbu Borole Date: Mon, 8 Jun 2026 12:02:31 +0530 Subject: [PATCH 4/8] update config.yml file --- docs/_config.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index eceec80..894522a 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,2 +1,7 @@ -title: To-Do service API -remote_theme: just-the-docs/just-the-docs \ No newline at end of file +title: KeepIT API +description: Digital archive manager +remote_theme: just-the-docs/just-the-docs + +# Required for just-the-docs nav to work +url: "https://khushbub.github.io" +baseurl: "/KeepIt" \ No newline at end of file From 7314f645fb3c9fbe0e791c150cb0db22bc798a17 Mon Sep 17 00:00:00 2001 From: Khushbu Borole Date: Mon, 8 Jun 2026 12:10:38 +0530 Subject: [PATCH 5/8] update index.md --- docs/index.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/index.md b/docs/index.md index 15e629c..c26973f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,27 @@ +--- +# markdownlint-disable +# vale off +# tags used by just-the-docs theme +layout: default +title: KeepIT API +nav_order: 1 +has_children: true +has_toc: true +# tags used by AI files +description: documentation landing page +topic_type: overview +ai_relevance: high +importance: 8 +related_pages: + - /Resources +version: "v1.0" +last_updated: "2026-03-01" +# vale on +# markdownlint-enable +--- + + # KeepIT API ## Archive it. Find it. Keep it. From c1bad5cb42fb4f85b584af867361ef8d9961944b Mon Sep 17 00:00:00 2001 From: Khushbu Borole Date: Mon, 8 Jun 2026 12:13:15 +0530 Subject: [PATCH 6/8] Update get-collection-by-id.md --- docs/articles/get-collection-by-id.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/articles/get-collection-by-id.md b/docs/articles/get-collection-by-id.md index 330305a..83a02d8 100644 --- a/docs/articles/get-collection-by-id.md +++ b/docs/articles/get-collection-by-id.md @@ -7,7 +7,7 @@ parent: Resources grand_parent: KeepIT API nav_order: 2 # tags used by AI files -description: GET all `collections` resources from the service +description: GET a `collections` resource by ID from the service topic_type: reference ai_relevance: high importance: 7 From 1bbd7008d6670a4b45a6952a23723e92df5402a9 Mon Sep 17 00:00:00 2001 From: Khushbu Borole Date: Mon, 8 Jun 2026 12:17:06 +0530 Subject: [PATCH 7/8] Updating front matter --- docs/articles/get-all-collection.md | 1 + docs/articles/get-collection-by-id.md | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/articles/get-all-collection.md b/docs/articles/get-all-collection.md index 6d8b86a..b476e0a 100644 --- a/docs/articles/get-all-collection.md +++ b/docs/articles/get-all-collection.md @@ -3,6 +3,7 @@ # vale off # tags used by just-the-docs theme layout: default +title: Get all collections parent: Resources grand_parent: KeepIT API nav_order: 1 diff --git a/docs/articles/get-collection-by-id.md b/docs/articles/get-collection-by-id.md index 83a02d8..7ed7be9 100644 --- a/docs/articles/get-collection-by-id.md +++ b/docs/articles/get-collection-by-id.md @@ -3,6 +3,7 @@ # vale off # tags used by just-the-docs theme layout: default +title: Get collections by ID parent: Resources grand_parent: KeepIT API nav_order: 2 From d1e4417bcc11ff15b3b1c8e31f12ceb747153b91 Mon Sep 17 00:00:00 2001 From: Khushbu Borole Date: Mon, 8 Jun 2026 12:21:37 +0530 Subject: [PATCH 8/8] fixing left navigation --- docs/_config.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index 894522a..012765c 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -4,4 +4,7 @@ remote_theme: just-the-docs/just-the-docs # Required for just-the-docs nav to work url: "https://khushbub.github.io" -baseurl: "/KeepIt" \ No newline at end of file +baseurl: "/KeepIt" + +# Keep all nav sections expanded at all times +nav_expand_all: true \ No newline at end of file