module-development

is there a module already made that does what csmms custom notification feature for discord?

heh ok ty

pog search by gamesererid?

This call with that filter :P

Ok, what's the preferred way to get players on a specific game server now?

That does a direct call to your gameserver -> very slow and no way to do any filtering or sorting or whatever

Oh yeah that doesn't look right :O But you actually don't want to use that API route, it should be deprecated

Uhhh, shouldn't this promise yield an array?

Hahaha well thank you for pointing it out 😄

It's actually been available for months but never documented, just a shadowy unsupported feature 🥷

If you run into stuff you want to extend but isn't available yet, let me know! I can add to this system :)

I'm stoked this is available now, it's incredible how often I need both player and pog hahaha

pogs for days!

Ok then 😄

Nothing nested possible there ;)

Oh ya I probably should have specified I'm talking about /players/search 🙂

Because you start from ShopOrders, which has a relation to listing, which relates to items (many-to-many table) and finally to items iteself

listing.items.item will still return an object

Yep! I screenshotted the real-life example from that docs page

Ah, nice of you to worry about that but no need. The bandwidth is in-cluster local network so it doesn't really matter much :p It's heckin fast

Errr I don't know what you mean by that. The web API docs you linked earlier show using hierarchal extensions. I think you call them "nested" on that docs page.

Ok all good, nbd just wondering if that's an option for conserving bandwidth since I'll probably end up doing these extensions A LOT now that they're availablel hehe

If it's not listed in here, you probably wont get it working :P

The nested stuff is only if it's actually supported by the underlying models

Don't think that'll work, no

Or it it object properties only?

How detailed can I be with hierarchel extensions? Can I do like

extend: ['playerOnGameServers.gameServerId']

to get back only gameServerId for pogs?

Yeah I know, that's why I realllllyyy want name on pog hahaha 🙂 Buttt now that you can extend player queries, that helps because I can get pog from player.

It's just all abstracted away from you so you don't really notice it unless you pay attention or look under the hood

Oh btw, just to be sure, the module code you write is actually calling the web API under the hood

It's there if people want to use it though :p Takaro itself is for sure the biggest consumer of the API 🤷‍♂️

Yeah I mean given that modules are the first class citizen to Takaro, IMO types documentation is more important. You can figure out web API stuff with that, and the type docs are invaluable for writing modules.

Tree made a web page showing stats using Takaro API a while ago but idk if that's still online

Hahah, by "any" what I actually mean is "pretty much anyone" lol

I know R20 made a Discord bot to automate some of his admin-y tasks (but that's mainly because Takaro doesnt have good enough Discord support yet, couldve been a module otherwise)

many is a big word :P

I mean directly, rather than via modules

Yeah I don't expect param definitions in OpenAPI for writing scripts. The TypeDoc source is much much more useful for writing modules.

Are many people actually using the web API?

Lots of stuff 🤣

I use this to generate a openapi spec from the code

And then I use openapi-generator to go from spec -> api client code

Rapidoc makes the interactive api docs page

And, typedoc to make the detailed code-gen docs

ope I see it on the doc page, TypeDoc

Well possible is good 🙂 Maybe someday!

What's the name of the doc generator?

It's totally possible though because the API docs has a 'description' field next to the properties. Just gotta untangle how to actually pass it from here all the way to the autogenerated docs 😄

Oh well, it all works without it and the group here being here to support it helps a lot

Yeh :( I haven't found a way to add comments to properties inside a request body

Ya, the auto gen documentation is super handy. The only thing that would help with that is doc comments to explain things, but understanding comes with experience haha

Good catch haha

😊

😉