5e-bits / 5e-bits/5e-database

Equipment category schema rationalization

Open
#397 11 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
TypeScript
Stars
934
Forks
427
Avg merge
17h 25m
Merged PRs (30d)
22

Description

There's a general schema for links to other entities that looks like this:

```json
"equipment_category": {
"index": "armor",
"name": "Armor",
"url": "/api/equipment-categories/armor"
},
```

But most of the subcategories in 5e-SRD-Equipment.json look like this instead:

```json
"armor_category": "Light",
```

The one exception to this is `gear_category`:

```json
"gear_category": {
"index": "standard-gear",
"name": "Standard Gear",
"url": "/api/equipment-categories/standard-gear"
},
```

My initial thought was that the categories that were represented as simple strings weren't found in 5e-SRD-Equipment-Categories.json, but nope:

```json
{
"index": "light-armor",
"name": "Light Armor",
"equipment": [
{
"index": "padded",
"name": "Padded",
"url": "/api/equipment/padded"
},
{
"index": "leather",
"name": "Leather",
"url": "/api/equipment/leather"
},
{
"index": "studded-leather",
"name": "Studded Leather",
"url": "/api/equipment/studded-leather"
}
],
"url": "/api/equipment-categories/light-armor"
},
```

I'm not sure what the policy is for breaking changes.

1. Can I put up a PR to fix this?
2. Since all of the subcategory types (`gear_category`, `armor_category`, `vehicle_category`, `tool_category`, `weapon_category`) appear at first glance to be mutually exclusive, can this be consolidated as an `equipment_subcategory` field?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.