Hello all,
This is an announcement for a breaking change to the output format of the WikibaseQualityConstraints constraint checking API, to go live on 6 May 2019 (most likely around 12:00 UTC). It affects all clients that use the *wbcheckconstraints* API action.
We are adding a new status for constraints https://lists.wikimedia.org/pipermail/wikidata/2019-April/012910.html, in addition to regular constraints and mandatory constraints: suggestion constraints indicate possible improvements to a statement, but are not inherently problematic like other constraint violations. This implies a new status for constraint results as well: in addition to 'violation' for violations of mandatory constraints and 'warning' for violations of regular constraints, as well as several statuses that are not violations, there is now 'suggestion' for violations of suggestion constraints. The default value of the status API parameter is changed to include this status as well (from violation|warning|bad-parameters to violation|warning|suggestion|bad-parameters), and it can appear as the "status" of a result in the response.
API consumers that are not interested in suggestion constraints can specify a non-default value for the status API parameter, e. g. the old default violation|warning|bad-parameters, to avoid getting responses including this status. Others should decide how to handle it, and update their code accordingly if necessary.
According to our stable interface policy https://www.wikidata.org/wiki/Wikidata:Stable_Interface_Policy, the change will be enabled 4 weeks after this announcement, on May 6th, and a test system will be set up latest on April 17th on test.wikidata.org.
If you have any question or issue, let us know in the related ticket https://phabricator.wikimedia.org/T204439.
Cheers,
Hello all, As promised, you can now test the new "wbcheckconstraints" API result status on test.wikidata.org. Here's an example https://test.wikidata.org/wiki/Q204283 of a constraint suggestion (you need to be logged-in to see the notification). If you have any question, please let me know. Cheers,
On Mon, 8 Apr 2019 at 14:26, Léa Lacroix lea.lacroix@wikimedia.de wrote:
Hello all,
This is an announcement for a breaking change to the output format of the WikibaseQualityConstraints constraint checking API, to go live on 6 May 2019 (most likely around 12:00 UTC). It affects all clients that use the *wbcheckconstraints* API action.
We are adding a new status for constraints https://lists.wikimedia.org/pipermail/wikidata/2019-April/012910.html, in addition to regular constraints and mandatory constraints: suggestion constraints indicate possible improvements to a statement, but are not inherently problematic like other constraint violations. This implies a new status for constraint results as well: in addition to 'violation' for violations of mandatory constraints and 'warning' for violations of regular constraints, as well as several statuses that are not violations, there is now 'suggestion' for violations of suggestion constraints. The default value of the status API parameter is changed to include this status as well (from violation|warning|bad-parameters to violation|warning|suggestion|bad-parameters), and it can appear as the "status" of a result in the response.
API consumers that are not interested in suggestion constraints can specify a non-default value for the status API parameter, e. g. the old default violation|warning|bad-parameters, to avoid getting responses including this status. Others should decide how to handle it, and update their code accordingly if necessary.
According to our stable interface policy https://www.wikidata.org/wiki/Wikidata:Stable_Interface_Policy, the change will be enabled 4 weeks after this announcement, on May 6th, and a test system will be set up latest on April 17th on test.wikidata.org.
If you have any question or issue, let us know in the related ticket https://phabricator.wikimedia.org/T204439.
Cheers,
Léa Lacroix Project Manager Community Communication for Wikidata
Wikimedia Deutschland e.V. Tempelhofer Ufer 23-24 10963 Berlin www.wikimedia.de
Wikimedia Deutschland - Gesellschaft zur Förderung Freien Wissens e. V.
Eingetragen im Vereinsregister des Amtsgerichts Berlin-Charlottenburg unter der Nummer 23855 Nz. Als gemeinnützig anerkannt durch das Finanzamt für Körperschaften I Berlin, Steuernummer 27/029/42207.