V1/V2 Shutting Down; Migration Guide

[gadhagod]

Unfortunately, with OpenAI's acquisition of Rockset, it has become unreasonable to migrate and maintain multiple copies of years-old data. For this reason, V1 and V2 will discontinued down on September 29th, 2024. If your applications depend on these versions, you need to migrate to V3 by this date to keep your application running.

Migration to V3:

• Category
  • V2 Endpoint: https://botw-compendium.herokuapp.com/api/v2/category/creatures
  • V3 Endpoint: https://botw-compendium.herokuapp.com/api/v3/compendium/category/creatures
  • Breaking changes: The food and non_food keys no longer exist. All entries are now siblings under a single array.
• All entries
  • V2 Endpoint: https://botw-compendium.herokuapp.com/api/v2
  • V3 Endpoint: https://botw-compendium.herokuapp.com/api/v3/compendium
  • Breaking changes: Entries are no longer nested under categories. All entries are now siblings under a single array.
• Master mode entry
  • V2 Endpoint: https://botw-compendium.herokuapp.com/api/v2/master_mode/entry/golden_bokoblin
  • V3 Endpoint: https://botw-compendium.herokuapp.com/api/v3/compendium/master_mode/entry/golden_bokoblin
  • Breaking changes: The food and non_food keys no longer exist. All entries are now siblings under a single array.
• Entry
  • V2 Endpoint: https://botw-compendium.herokuapp.com/api/v2/entry/horse
  • V3 Endpoint: https://botw-compendium.herokuapp.com/api/v3/compendium/entry/horse
  • Breaking changes: Probably none. See V3 entry schemas.
• Entry image
  • V2 Endpoint: https://botw-compendium.herokuapp.com/api/v2/entry/horse/image
  • V3 Endpoint: https://botw-compendium.herokuapp.com/api/v3/compendium/entry/horse/image
  • Breaking changes: None

To see new V3 features, please look at the ticked boxes under #30.

[freshefisch]

Is there any way to selfhost v3 since the move to MongoDB? I was planning on adding the TotK images, so I would have liked to host the API locally to test it.

I was bit confused, since the self hosting guide seems to be very much out of date. Since then, both db/ and scripts/get_data.py have been deleted, and the guide talks about hosting on Rockset. Where is the actual data located now?

I don't have any experience with databases, so I apologize if I'm missing the obvious.

If self hosting is not possible, what modifications would be necessary to make the TotK images work? Would it be enough to add them to images/TOTK with the correct filenames (just like the BotW ones)?