Page MenuHomePhabricator

Document JSON serialization format of ChangeOp serialization (used in data parameter of API action wbeditentity)
Closed, ResolvedPublic

Description

The only documentation of the "serialization" format used in the data parameter of action=wbeditentity I could find is some examples provided in the auto-generated API help (see e.g. Examples at https://www.wikidata.org/w/api.php?action=help&modules=wbeditentity), and some examples on the help page on mediawiki.org (https://www.mediawiki.org/wiki/Wikibase/API#wbeditentity). These are, I believe, not enough.

We should consider what would be the best way of documenting this format. Should it be a separate document in docs directory of the Wikibase repository? Once the current format is described it would also be nice (and so much easier) to update examples in both places listed above.

Extensions providing custom entity types (MediaInfo, Lexeme etc) should be also documenting their specific ChangeOps.

Event Timeline

daniel awarded a token.
daniel added a project: Documentation.
daniel moved this task from Inbox to To Do on the User-Daniel board.Jan 5 2017, 4:07 PM
daniel moved this task from To Do to Push on the User-Daniel board.Jan 5 2017, 4:10 PM

Change 333007 had a related patch set uploaded (by Thiemo Mättig (WMDE)):
Document JSON serialization format of ChangeOp serialization

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

thiemowmde moved this task from Proposed to Review on the Wikidata-Former-Sprint-Board board.
thiemowmde moved this task from incoming to in progress on the Wikidata board.

Change 333007 merged by jenkins-bot:
Document JSON serialization format of ChangeOp serialization

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