Page MenuHomePhabricator

Remove link to defunct https://rest.wikimedia.org/ on https://doc.wikimedia.org/
Closed, ResolvedPublic

Event Timeline

Mvolz triaged this task as Lowest priority.Jul 11 2019, 12:52 PM
Mvolz added a project: good first task.
Mvolz updated the task description. (Show Details)
Legoktm subscribed.

Is there a replacement target, or should it just be removed outright?

Is there a replacement target, or should it just be removed outright?

The docs for the API are now via a spec.yaml file that's part of the deployed service (i.e. https://en.wikipedia.org/api/rest_v1/ for example), but this just documents the API, not the code itself, so I don't really think it belongs there.

As far as I know this is the only other documentation is https://www.mediawiki.org/wiki/RESTBase and
https://github.com/wikimedia/restbase/tree/master/doc

Maybe @Pchelolo or @mobrovac have a more informed opinion?

I would like to work on this, and I think it should link to page on MediaWiki, but noone no responded until today.

On doc.wikimedia.org, we usually target developers contributing to the software or developers making use of the programmatic interface of the software. For RESTBase, there isn't yet currently an auto-generated JSDoc3 or JSDuck output configured. Instead, the software is documented in pure Markdown at https://github.com/wikimedia/restbase/tree/master/doc. Perhaps we can link that instead?

Change 547846 had a related patch set uploaded (by Ammarpad; owner: Ammarpad):
[integration/docroot@master] Update RESTBase link

https://gerrit.wikimedia.org/r/547846

Change 547846 merged by jenkins-bot:
[integration/docroot@master] Update RESTBase link

https://gerrit.wikimedia.org/r/547846