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

Equipment category schema rationalization

Aberta
#397 11 comentários 0 reações 0 responsáveis Ver no GitHub
good first issue
Linguagem predominante
TypeScript
Estrelas
934
Forks
427
Merge médio
17h 25min
PRs com merge (30d)
22

Descrição

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?

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Examine the JSON schema in the repository, particularly 5e-SRD-Equipment.json and 5e-SRD-Equipment-Categories.json. Understand the current structure of equipment categories and subcategories. The task is to rationalize the schema, potentially changing string fields to structured objects and possibly consolidating subcategory fields. Check for any existing tests or validation scripts to ensure changes are consistent. The goal is a PR that aligns the schema without breaking existing API consumers.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
json, typescript
Domínio
api, database
Tipo de issue
Refatoração
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.