KebsCS / lcu-and-riotclient-api

League of Legends LCU and Riot Client API Docs
https://lcu.kebs.dev
68 stars 2 forks source link

Missing Type Information #1

Closed xuri-ajiva closed 1 year ago

xuri-ajiva commented 1 year ago

While using the API documentation, it was noticed that there is missing type information for one or more parameters or responses. It would be nice if the API documentation could include complete type information for all parameters and responses or provide a link to where they can be found.

KebsCS commented 1 year ago

Hi, is this what you meant? https://github.com/KebsCS/lcu-and-riotclient-api/commit/d4f1eaaf9c7d6e92dd927e8083446d3c2b75c433

xuri-ajiva commented 1 year ago

Yes, but there is a minor issue to address regarding certain routes that contain recursive objects such as maps. For instance, the route "PUT /lol-chat/v1/me" has a parameter called "lol" which is a map type. However, it is unclear what values are acceptable for this parameter. Unfortunately, I have no suggestion how to display it visually, maybe an example in json?

KebsCS commented 1 year ago

You can do GET /lol-chat/v1/me and it'll show you an example. I just use what's available in the client for the docs and there is no explaination what's a map

xuri-ajiva commented 1 year ago

You're right, does this apply to all routes? Where did you get all the info from?

Neinndall commented 1 year ago

hi @KebsCS so as not to create a thread, I would like to know how to use it, I was looking for a way to make a request, to be able to get the info of the PASS track of the events, I mean, the battle pass ^^ I've never used this language, I suppose you could give me a hand, on command issues, to make it easy for me.

KebsCS commented 1 year ago

hi @KebsCS so as not to create a thread, I would like to know how to use it, I was looking for a way to make a request, to be able to get the info of the PASS track of the events, I mean, the battle pass ^^ I've never used this language, I suppose you could give me a hand, on command issues, to make it easy for me.

https://www.google.com/search?q=lcu+api+tutorial