Spage added a subscriber: Christopher. Spage added a comment. In https://phabricator.wikimedia.org/T359#1013892, @Qgil wrote:
> I wonder how these Wikidata API docs will look like, and where will be they > published. > > In the masterplan, we have agreed that API references should be documented > directly in the source code, using the best tool for output. In the case of > Wikidata, these APIs are extended MediaWiki APIs. They are referenced in > https://www.wikidata.org/w/api.php mixed with all the rest. BTW you can show the generated API documentation for a single action with a parameter, e.g. https://www.wikidata.org/wiki/Special:ApiHelp/wbgetentities > What is the best way to show them to 3rd party developers willing to learn > only about these APIs? I think an on-wiki introduction with motivation and explanation is the way to go. The generated API doc could have a substantial intro explaining items, snaks, etc. but it would have to be repeated for each wikibase API action and we'd need to reproduce wiki markup for sectioning and linking. I'm undecided whether to have examples both in the API, and in the wiki page (T88755: Improve MediaWiki API example behavior <https://phabricator.wikimedia.org/T88755>). > On the other hand, we have https://www.mediawiki.org/wiki/Wikibase/API which > I guess is written manually. Will we keep this duplication? Per above, yes. What's confusing me is that page is currently full of generic API documentation and nothing relevant to wikibase! The May 2014 <https://www.mediawiki.org/w/index.php?title=Wikibase/API&oldid=995552> version talks about Wikibase , has helpful advice, and good examples, etc., but then @Christopher (Johnson of WMDE) replaced it with "Please see wikidata.org/w/api.php for a perfectly up to date copy" and then User:D konto (Dionysia Kontotasiou) added a bunch of generic information. I'll revive the May 2014 revision. > PS: this is the type of problems that the new Developer Hub needs to solve. indeed! TASK DETAIL https://phabricator.wikimedia.org/T359 REPLY HANDLER ACTIONS Reply to comment or attach files, or !close, !claim, !unsubscribe or !assign <username>. EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/ To: Spage Cc: Christopher, Addshore, Lucie, Spage, daniel, aude, Lydia_Pintscher, Qgil, Wikidata-bugs _______________________________________________ Wikidata-bugs mailing list Wikidata-bugs@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs
