MHWDB-Docs icon indicating copy to clipboard operation
MHWDB-Docs copied to clipboard

Retrieve API version

Open kacperfleszar opened this issue 4 years ago • 8 comments

Hi!

Is it possible to retrieve current API version by API call? Something like: GET https://mhw-db.com/version I'm using your API in Java app and I would like to create some regression tests to check if something changes.

Thanks, Kacper

kacperfleszar avatar Nov 23 '19 23:11 kacperfleszar

It isn't currently possible, but I can add it to the backlog! I'll update this issue again once it's been added.

LartTyler avatar Nov 26 '19 16:11 LartTyler

Great, thanks for the answer!

kacperfleszar avatar Nov 26 '19 17:11 kacperfleszar

Adding on to this, curious as to what typically motivates a version change? Just updates to the structure of the data? Or additions to the data itself: new armor, weapons, etc?

mitchjmac avatar Mar 27 '20 23:03 mitchjmac

For the most part it's data schema changes or data field deprecation/removals. @LartTyler Can advise in more detail.

DeveloperPaul123 avatar Mar 28 '20 00:03 DeveloperPaul123

That's all I needed to know, thanks!

mitchjmac avatar Mar 29 '20 07:03 mitchjmac

Specifically, patch versions (e.g. 1.18.x) are generally reserved for fixes to things. So if validation is wrong for an object, or if the data it's returning isn't a consistent shape, that'll be part of a patch release. A minor version (e.g. 1.x) generally contains new features or fields / objects. It can also contain deprecations for older features that are being replaced, with old deprecated features being removed in the minor version following the release that deprecated them.

LartTyler avatar Mar 29 '20 15:03 LartTyler

@LartTyler Since you closed this issue, does it mean it's now possible to retrieve the version of the API?

DeveloperPaul123 avatar Mar 29 '20 16:03 DeveloperPaul123

Nope, it was a misclick. Thanks for pointing it out!

LartTyler avatar Mar 29 '20 16:03 LartTyler