Nookipedia / nookipedia-api

Nookipedia's custom API for querying data from the Animal Crossing video game series.
https://api.nookipedia.com/
MIT License
40 stars 12 forks source link

Fix `cub`, `rhino` and `sisterly` in docs #88

Closed maxswa closed 1 year ago

maxswa commented 1 year ago

It looks like in previous versions of the API, the species Bear cub and Rhinoceros and the personality Big sister were being converted to Cub, Rhino and Sisterly respectively. In both the query and formatter code.

https://github.com/Nookipedia/nookipedia-api/blob/c0ea49bed69d55db668e7fc0218e27f14916d6c7/nookipedia/models.py#L21-L27

However, in versions past 1.3 this is no longer the case. In the query code cub, rhino and sisterly are being converted to their proper, more verbose aliases. While in the formatter code, they are being set to Bear cub, Rhinoceros and Big sister

https://github.com/Nookipedia/nookipedia-api/blob/c0ea49bed69d55db668e7fc0218e27f14916d6c7/nookipedia/cargo.py#L280-L281 https://github.com/Nookipedia/nookipedia-api/blob/c0ea49bed69d55db668e7fc0218e27f14916d6c7/nookipedia/cargo.py#L335-L338

This PR corrects the doc.yaml to correctly reflect these cases by adding the proper names to the query enums and replacing the aliases with the proper names in the response enums.

KevinPayravi commented 1 year ago

Thanks for these fixes!