Reedy added a comment.
Something that appears in/is linked from the API help pages, and therefore by
design is also on Special:ApiSandbox feels more streamlined than something
seperate and disjointed, or requires other discovery to find it.
While it's extra docs to keep upto date (but I imagine it doesn't change
often?), copy pasta of the bulk of this section (minor tweaks maybe needed?)
into the description (seemingly `apihelp-query+wbentityusage-param-aspect` and
`apihelp-query+wblistentityusage-param-aspect` as they both use the `Only
return entity IDs that used this aspect.` string) would probably work best
Entity usage on client pages is tracked using the following codes (each
representing one aspect):
sitelinks (S) - The entity's sitelinks are used.
label (L.xx) - The entity's label in language xx is used.
description (D.xx) - The entity's description in language xx is used.
title (T) - The title of the local page corresponding to the entity is
used.
statements (C) - Certain statements (identified by their property id)
from the entity are used.
other (O) - Something else about the entity is used. This currently
implicates statement and description usage.
all (X) - All aspects of an entity are or may be used.
While it would be nice if the API allowed seperate documentation of those
list of values, it's obviously out of scope for this request, and would become
a dependancy on being able to use it. Engineering effort suggests it's probably
likely to end up low on a list of things to be done; but I will file a bug.
The first similar example I can find in the API is for "error format`:
"apihelp-main-param-errorformat": "Format to use for warning and error
text output.\n; plaintext: Wikitext with HTML tags removed and entities
replaced.\n; wikitext: Unparsed wikitext.\n; html: HTML.\n; raw: Message key
and parameters.\n; none: No text output, only the error codes.\n; bc: Format
used prior to MediaWiki 1.29. <var>errorlang</var> and
<var>errorsuselocal</var> are ignored.",
Which results in something like
F34485553: Screenshot 2021-06-07 at 14.38.14.png
<https://phabricator.wikimedia.org/F34485553>
Which obviously also makes it translateable, where a link to
https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_usagetracking.html
is not.
TASK DETAIL
https://phabricator.wikimedia.org/T283040
EMAIL PREFERENCES
https://phabricator.wikimedia.org/settings/panel/emailpreferences/
To: Reedy
Cc: Addshore, RBrounley_WMF, Aklapper, Reedy, Invadibot, maantietaja,
Akuckartz, apaskulin, Nandana, lucamauri, Cpaulf30, Lahi, Gq86,
GoranSMilovanovic, Ivana_Isadora, QZanden, LawExplorer, _jensen, rosalieper,
Scott_WUaS, Wikidata-bugs, aude, Dinoguy1000, Mbch331, Jay8g
_______________________________________________
Wikidata-bugs mailing list -- wikidata-bugs@lists.wikimedia.org
To unsubscribe send an email to wikidata-bugs-le...@lists.wikimedia.org
