search

boraarslan / mapper-influence

0 stars 0 forks source link

User and Beatmap endpoints #21

Closed 112batuhan closed 1 year ago

112batuhan commented 1 year ago

I added the user and Beatmap endpoints to the API library. The current response fields can be overkill but they can be removed. I think deleting is easier than adding so I left a lot of the fields in the code.

I left the tests as example and they can be removed before merging.

Fursum commented 1 year ago

Would be nice to prune the unnecessary data from the map endpoint. Users can access the detailed information from the official map page.

:information_source: Current essential map data fields
  • Artist
  • Song title
  • Difficulty name
  • Link to map or mapset and difficulty id
  • Background url or mapset id

there is also a need for a base user data endpoint with these fields:

:information_source: Current essential base user data fields
  • User id
  • Username
  • Avatar url
  • User group
    I want to display titles like Elite Mapper. That might not be in the groups.
112batuhan commented 1 year ago

I removed the colour struct and added module level docs as first start. I think we should just merge this pr first before I open another pr for docs so you can start working with this if you want.

112batuhan commented 1 year ago

I also couldn't get cargo doc to generate items. It only generates the index page and nothing else. Even when I use cargo doc --workspace. Is there something else I should be doing? I think it generates the pages in target/doc but doesn't show in browser.