Skip to content

Commit 8023cda

Browse files
authored
Update API.md
1 parent 4cc17ae commit 8023cda

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

API.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It is deployed via GitHub Pages at:
1111
https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/
1212
```
1313

14-
> [!NOTE]
14+
> **Note**
1515
> Endpoints are **static**. They update only when the repo is updated.
1616
1717
---
@@ -30,51 +30,53 @@ https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/
3030

3131
---
3232

33-
### Metadata
33+
## Metadata
3434
- **[`stats.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/stats.json)**
3535
Aggregate counts by type, Minecraft version, and creator.
3636

3737
- **[`versions.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/versions.json)**
38-
List of all supported Minecraft versions.
39-
- Includes **unique + sorted** versions.
40-
- Expands ranges (e.g., `"1.20.1-1.21.4"`) into **all discrete versions**:
41-
`1.20.1, 1.20.2, 1.20.4, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4`.
38+
List of all supported Minecraft versions.
4239

4340
- **[`creators.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/creators.json)**
4441
List of all creators with plugin/theme counts.
4542

4643
- **[`meta.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/meta.json)**
47-
Metadata about the dataset (generation timestamp, item counts, source commit).
44+
Metadata about generation time + counts.
4845

4946
- **[`manifest.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/manifest.json)**
50-
Integrity manifest: SHA256 + file size for all API files.
47+
SHA256 & size for all API files.
5148

5249
- **[`search-index.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/search-index.json)**
53-
Compact index for search (name, slug, creator, tags, versions).
50+
Compact search index.
5451

5552
---
5653

57-
> [!TIP]
58-
> Slugs (`/items/`, `/by-creator/`, `/by-version/`) are **lowercased** and URL-safe.
54+
## Activity (New & Recently Updated)
5955

60-
### Per-item
56+
These files rely on the YAML fields `added_at` and `updated_at`:
57+
58+
- **[`new.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/new.json)**
59+
Recently added items (sorted by newest `added_at`).
60+
61+
- **[`recent.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/recent.json)**
62+
Recently updated items (sorted by newest `updated_at` or `added_at`).
63+
64+
---
65+
66+
## Per‑Item
6167
- **`/items/{owner}/{repo}.json`**
62-
One file per plugin/theme, using the GitHub repo slug.
6368
Example:
6469
[`items/kybe236/rusher-silent-close.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/items/kybe236/rusher-silent-close.json)
6570

6671
---
6772

68-
### Buckets (Filters)
73+
## Buckets (Filtered Views)
74+
6975
- **`/by-version/{mc_version}.json`**
70-
All plugins/themes supporting that exact Minecraft version.
71-
- Works with **discrete versions only**.
72-
- Ranges from source data are automatically expanded.
7376
Example:
7477
[`by-version/1.21.4.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/by-version/1.21.4.json)
7578

7679
- **`/by-creator/{creator}.json`**
77-
All plugins/themes by a given creator (lowercased slug).
7880
Example:
7981
[`by-creator/tillay.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/by-creator/tillay.json)
8082

@@ -100,13 +102,10 @@ curl -s https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/stats.json
100102
---
101103

102104
## Showcase
103-
104-
Here’s a live example:
105-
106-
- **[RusherSearch](https://garlicrot.github.io/RusherSearch/)** ([repo](https://github.com/GarlicRot/RusherSearch))
107-
A simple static search frontend that consumes the API to provide instant plugin & theme lookup with filtering, creator avatars, and version tags.
105+
- **[RusherSearch](https://garlicrot.github.io/RusherSearch/)**
106+
Instant search UI consuming the API.
108107

109108
---
110109

111-
> [!IMPORTANT]
112-
> This is an **unstable v1**. Shapes may evolve slightly as we improve consistency.
110+
> **Important:**
111+
> This is an early **v1**. API shapes may slightly evolve.

0 commit comments

Comments
 (0)