MineSkin / api.mineskin.org

Source of the MineSkin API
https://api.mineskin.org
MIT License
50 stars 5 forks source link

API does not match OpenAPI specification #327

Closed TobiasDeBruijn closed 3 years ago

TobiasDeBruijn commented 3 years ago

The Mineskin API at https://api.mineskin.org does not match the OpenAPI specification here

Examples

What were you expecting to happen?

The API should follow the OpenAPI specification, or the OpenAPI specification should be updated to match the API

InventivetalentDev commented 3 years ago

should be included as query parameter key

It also mentions that you can provided it in the header, which is also the preferred method:

Authorization: Bearer myapikey

I'll have a look why it's having issues with the query one though. Query key works fine for me too if the key is valid. Fixed the timeout for invalid keys.

However the real API expects it as the query parameter uuid

It doesn't. Works perfectly fine for me providing it in the body. Make sure you're using the correct Content-Type header.

TobiasDeBruijn commented 3 years ago

It also mentions that you can provided it in the header, which is also the preferred method:

This Bearer token, is it just the same as if I'd put the key in the query? i.e Authorization: Bearer <API KEY>

It doesn't. Works perfectly fine for me providing it in the body. Make sure you're using the correct Content-Type header.

That would be why then. I was not explicitly setting any header.

I see what my auth issue was, I had removed all allowed User-Agents in the API key manager. However these don't seem to persist.

InventivetalentDev commented 3 years ago

is it just the same as if I'd put the key in the query

yep.

TobiasDeBruijn commented 3 years ago

Awesome. Thanks for clearing up the confusing and fixing the timed out issue!