mtgjson / mtgjson-website

MTGJSON Documentation Front-End Application built with VitePress
https://mtgjson.com
MIT License
36 stars 24 forks source link

Non-documented `etched` property in `PricePoints` data model #646

Open grim7reaper opened 3 weeks ago

grim7reaper commented 3 weeks ago

Location of update needed

PricePoints data model

What does the documentation look like?

Only foil and normal properties are documented, but some instance also have an etched property. Cf. AllPrices.json and AllPricesToday.json

"88efa464-925a-5de1-a66a-5cdf8d159277": {
  "mtgo": {
    "cardhoarder": {
      "buylist": {},
      "retail": {
        "normal": {
          "2024-08-15": 0.12
        }
      },
      "currency": "USD"
    }
  },
  "paper": {
    "tcgplayer": {
      "buylist": {},
      "retail": {
        "normal": {
          "2024-08-15": 3.73
        },
        "foil": {
          "2024-08-15": 6.05
        },
        "etched": {
          "2024-08-15": 5.45
        }
      },
      "currency": "USD"
    },
    "cardmarket": {
      "buylist": {},
      "retail": {
        "normal": {
          "2024-08-15": 2.82
        },
        "etched": {
          "2024-08-15": 4.99
        }
      },
      "currency": "EUR"
},

What should the documentation look like?

Add the field in the type:

etched?:  Record<string, number>;

and the relevant documentation:

etched

The card's etched product price, where the key is the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date and value is its price.

- Type: `Record<string, number>`
- Introduced: `v5.2.2`

(not 100% sure about the Introduced: v5.2.2, I just copy-pasted from the other fields

Additional context

I'm using MTGJSON 5.2.2+20240815