Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
title: Keepit service API
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"

# Keep all nav sections expanded at all times
nav_expand_all: true
39 changes: 39 additions & 0 deletions docs/articles/Resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
# markdownlint-disable
# vale off
# tags used by just-the-docs theme
layout: default
title: Resources
parent: KeepIT API
nav_order: 2
has_children: true
has_toc: true
# 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-collection-by-id
examples: []
api_endpoints: []
version: "v1.0"
last_updated: "2026-03-01"
# vale on
# markdownlint-enable
---

<!-- vale off -->

# 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)
108 changes: 108 additions & 0 deletions docs/articles/get-all-collection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
# markdownlint-disable
# vale off
# tags used by just-the-docs theme
layout: default
title: Get all collections
parent: Resources
grand_parent: KeepIT API
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
---

<!-- vale off -->

# 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. |
87 changes: 87 additions & 0 deletions docs/articles/get-collection-by-id.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
# markdownlint-disable
# 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
# tags used by AI files
description: GET a `collections` resource by ID 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
---

<!-- vale off -->

# 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. |
39 changes: 32 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +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
---

<!-- vale off -->

# KeepIT API

## Archive it. Find it. Keep it.
Expand All @@ -22,19 +46,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

Expand Down
Loading