top-gg / docs Goto Github PK

Just for a good cause, but... I think it's beautiful 😂.

html:

<script src="https://twemoji.maxcdn.com/v/latest/twemoji.min.js" crossorigin="anonymous"></script>

js:

twemoji.parse(document.body)

css:

/*Blablabla*/
img.emoji {
width: 1em;
}

I hope this is a good thing... eh... Here I go!

Hi, when I try to respond to a Rating & Review, it doesn't respond and post my response as a comment

• 👋 Hi, I’m @calbearox

Heya,

I've recently implemented into my own top.gg Java SDK webhook support, so I've figured out that I could write this issue.

The current Java library is ... in a rough state since it was not working but maybe now it does, I don't really know really + you must use JitPack which is quite annoying IMO. My idea is just to put it there as a lightweight alternative to the already existing one.

I can write any additional docs if needed or create a whole PR.

GitHub repo of the library: https://github.com/lilmayu/top-gg-java-sdk

Also, rate limits will be supported as well in the future.

https://docs.top.gg/resources/ratelimits/

Should be millisecond not milisecond

The example response below the "post stats" endpoint gives an example response for a different endpoint.

https://docs.top.gg/api/bot/#bot-structure:

I believe this is supposed to render as ⚠️?

Browser: Chromium 93.0.4577.63 (Official Build) Arch Linux (64-bit)

Example

Relevant for #44

MechArena

Posting to /bots/:id/stats is wrong. It returns {"error": "Forbidden"}.

It works when you POST to /bots/stats

Issue: https://github.com/top-gg/docs/blob/master/docs/Resources/webhooks.mdx#bot-webhooks

Problem:
The documentation says the query parameter is sent as a string. This is incorrect. It's sent as an object with parameters as properties and their values as the property values.

Actual payload example from the webhook:

{
   user: '491002268401926145',
   type: 'upvote',
   query: { source: 'command' },
   isWeekend: true,
   bot: '675996677366218774'
 }

Solution:
The query parameter description needs to be fixed to reflect the fact the webhook sends this property as an object with the parameters as properties inside that object, and not a string.

Expected Behavior

Get the link https://top.gg/api/bots copied after clicking on the "Copy URL" button of the API documentation.

Observed Behavior

Got the link https://top.gg/api//bots copied after clicking the button.

Applicable Links or Attachments

https://docs.top.gg/api/bot

Steps to Reproduce

1. Open docs.top.gg
2. Click on the Bot or another resource where you can copy a link
3. Click on "Copy link"

Web Browser and Version

Microsoft Edge - 90.0.818.62 Official build) (64-bit)

Operating System and Version

Windows 10

Screen Resolution

3440x1440

Additional Information/Comments

It's not a big deal, as the URL is still considered as valid.