Page MenuHomePhabricator

write documentation for how to authenticate with the Wikibase REST API
Closed, ResolvedPublic

Description

As a programmer using the Wikibase REST API I want to understand how to authenticate with the API in order to perform actions that require authentication.

Problem:
We currently don't have documentation for this. We need it because it'll prevent people from being able to use the API.

Acceptance criteria:

Event Timeline

I'll need to speak with a subject-matter expert on this one. Who's the right person?

@WMDE-leszek or someone he delegates to from the developers

Is there anything we can do to unblock this. This is getting urgent and people are asking.

Okay, I'll treat this as extremely urgent.

Todo: error states & rate limiting

@danshick-wmde I assume this is done with the latest changes you made? Or is there still something missing?

I had a chat with Ollie scheduled for yesterday which got cancelled since he's at a conference. I still need to formalize on the wiki page the stuff he & others said on Mattermost about error states (documented in Swagger) and rate limiting (fundamentally the same as ActionAPI, but I need to note how they're implemented on Wikidata). I'll attempt to finish this today, tomorrow at the latest.

I had a chat with Ollie scheduled for yesterday which got cancelled since he's at a conference. I still need to formalize on the wiki page the stuff he & others said on Mattermost about error states (documented in Swagger) and rate limiting (fundamentally the same as ActionAPI, but I need to note how they're implemented on Wikidata). I'll attempt to finish this today, tomorrow at the latest.

Correction, I already formalized the language about error states. Still needed to add something about $wgRateLimit, which I've just done. The other thing I was waiting for was a thumbs-up or thumbs-down about communicating the actual values for $wgRateLimits set for Wikidata, but for now I'll leave that alone.

danshick-wmde updated the task description. (Show Details)

Yesterday Silvan pointed out that this issue is actually about users getting 403 "rest-write-denied" errors when lacking bot permissions. Some context apparently at T321318 . I have a subject-matter-expert interview tomorrow with @WMDE-leszek , will try to get to the bottom of this behavior then.

Added a note about the bot flag.

Thank you for these docs! They'll be very useful for my Ruby gem :)