shields icon indicating copy to clipboard operation
shields copied to clipboard

add [curseforge] downloads badge

Open Minecraftschurli opened this issue 4 years ago • 7 comments

this PR adds the curseforge downloads badge requested in #4498

it includes:

  • auth helpers
  • documentation for the api token
  • the curseforge downloads badge

it sadly requires an api token to work for which the process for acquiring can be found here

Minecraftschurli avatar Jan 16 '22 17:01 Minecraftschurli

Warnings
:warning: This PR modified the server but none of its tests.
That's okay so long as it's refactoring existing code.
Messages
:book:

Thanks for contributing to our documentation. We :heart: our documentarians!

:book: :sparkles: Thanks for your contribution to Shields, @Minecraftschurli!

Generated by :no_entry_sign: dangerJS against fa306055d85e63995e361915635b988dab73eb1c

shields-ci avatar Jan 16 '22 17:01 shields-ci

Thanks for the PR!

it sadly requires an api token to work for which the process for acquiring can be found here

Do you know how the authorization is scoped? I.e. will a request that authenticates with a valid token be allowed to pull data for any target, or does the token have to be explicitly authorized/scoped to the target in order to work?

calebcartwright avatar Jan 16 '22 17:01 calebcartwright

it is an api token auth which is normally not scoped (in this case it is unscoped)

Minecraftschurli avatar Jan 16 '22 17:01 Minecraftschurli

I have tested it with my api token and it worked (I didn't have to set any scopes)

Minecraftschurli avatar Jan 16 '22 17:01 Minecraftschurli

The process for requesting an api key looks notably more involved and complicated than what we typically have to go through. What was your experience like?

calebcartwright avatar Jan 16 '22 17:01 calebcartwright

I used the game developer api key which just requires a google account login

Minecraftschurli avatar Jan 16 '22 17:01 Minecraftschurli

I used the game developer api key which just requires a google account login

Gotcha. We're going to need some time to talk this over amongst the core team, as well as likely needing to have a dialog with the Curseforge folks to determine if/when this might be viable to proceed.

calebcartwright avatar Jan 16 '22 17:01 calebcartwright

Any news ?

curio-sitas avatar Dec 05 '22 20:12 curio-sitas

?

starboyceleste avatar Mar 31 '23 02:03 starboyceleste

This work was effectively merged via #9252. Thanks for the contribution and the patience!

PyvesB avatar Aug 13 '23 18:08 PyvesB