Last modified: 2014-05-01 20:08:04 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T66594, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 64594 - Improve documentation of supported formats and data structures for different data types.
Improve documentation of supported formats and data structures for different ...
Status: NEW
Product: MediaWiki extensions
Classification: Unclassified
WikidataRepo (Other open bugs)
unspecified
All All
: Normal normal (vote)
: ---
Assigned To: Wikidata bugs
u=dev c=documentation p=0
: need-volunteer
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2014-04-29 10:56 UTC by Daniel Kinzler
Modified: 2014-05-01 20:08 UTC (History)
4 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Daniel Kinzler 2014-04-29 10:56:54 UTC
We currently document the structure of data values on Special:ListDatatypes. While this is better than nothing, it's really misleading, and missing important information. It's also nearly impossible to discover.

The relevant help page (or special page) should be linked from the API's self documentation, and from the relevant error messages shown to the user.

The documentation on Special:ListDatatypes should include, for each data type:

* Supported plain string representations (this info must be supplied be the parser). This is the relevant information for people interacting with the UI directly.
* The data value type, and the JSON structure used to represent the data value.
* Semantics of the individual fields of the JSON structure.
* Constraints imposed by the data value's validators (should be provided by the data type factory).

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links