Please find the differences between the two outputs; particularly data that is in the OpenRefine file and not in the prototype. Wherever possible, we should also document the "why" behind the differences.
Key differences to consider:
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| Add docs - Manifest Output Format | mediawiki/extensions/WikibaseManifest | master | +122 -0 |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | darthmon_wmde | T261285 [EPIC] Decide on output format for v1 of the WBManifest extension (product specification doc) | |||
| Resolved | • Tonina_Zhelyazkova_WMDE | T260982 [Investigation: Timebox 4 hours] Compare prototype output with json-schema from OpenRefine |
Key differences to consider:
OpenRefine's Manifest Schema spec
WikibaseManifest prototype
| Options | Entity mapping | Properties | QualityConstraints |
|---|---|---|---|
| WikibaseManifest Prototype | maps entity ids, where the key is the Wikidata entity and the value is the local wikibase entity, e.g. "P31": "P1" | has "instance_of" | does not have it |
| OpenRefine Manifest Spec | lists the label and the respective id on the local wikibase, e.g. “instance_of”: “P1” | has "instance of" and "subclass_of" | lists them but it's optional as QualityContraints is an extension and it might not be installed on some Wikibases |
| Comment | We should find out which format is more convenient for tool builders | Maybe we should look at Basic membership properties to see the full list and decide which we want to include | We might not provide them in v1 of WikibaseManifest |
| Options | OAuth | Reconciliation | EditGroups |
|---|---|---|---|
| WikibaseManifest Prototype | does not have it | has it as an external service | does not have it |
| OpenRefine Manifest Spec | lists the configs but it's optional, if available it requires the URL of the registration page, e.g. https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose | has it and it's required | has it as optional, and if provided it needs a url_schema. The URL schema must contain the variable ${batch_id} |
| Comment | |||
| Options | RDF Namespaces | MediaWiki info | Other |
|---|---|---|---|
| WikibaseManifest Prototype | has them listed | lists the Wikibase name and root URL | Lists the namespaces for item and property |
| OpenRefine Manifest Spec | does not have them | Requires the name of the Wikibase, e.g. Wikidata, the URL of the root, e.g. https://www.wikidata.org/wiki/, main page URL, e.g. https://www.wikidata.org/wiki/Wikidata:Main_Page and the API endpoint, e.g. https://www.wikidata.org/w/api.php | requires max_lag and site_iri |
| Comment | No harm in keeping them | We should craft a list of MediaWiki configs we can expose |
Here is my take with changes marked in italic
| Options | Entity mapping | Properties | QualityConstraints |
|---|---|---|---|
| WikibaseManifest Prototype | maps entity ids, where the key is the Wikidata entity and the value is the local wikibase entity, e.g. "P31": "P1" | no specific section, but can be mapped as entities | no specific section, but can be mapped as entities |
| OpenRefine Manifest Spec | lists the label and the respective id on the local wikibase, e.g. “instance_of”: “P1” | has "instance_of" and "subclass_of", required | lists 17 properties and 47 items for wikidata. Otherwise optional, as QualityContraints is an extension and it might not be installed on some Wikibases |
| Comment | We should find out which format is more convenient for tool builders | Maybe we should look at Basic membership properties to see the full list and decide which we want to include | We might not provide them in v1 of WikibaseManifest |
| Options | OAuth | Reconciliation | EditGroups |
|---|---|---|---|
| WikibaseManifest Prototype | does not have it | allows it as an external service | does not have it |
| OpenRefine Manifest Spec | lists the configs but it's optional, if available it requires the URL of the registration page, e.g. https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose | has it and it's required | has it as optional, and if provided it needs a url_schema. The URL schema must contain the variable ${batch_id} |
| Comment | |||
| Options | RDF Namespaces | MediaWiki info | Other |
|---|---|---|---|
| WikibaseManifest Prototype | has them listed | lists the Wikibase name and root URL | Lists the namespaces for item and property |
| OpenRefine Manifest Spec | does not have them | Requires the name of the Wikibase, e.g. Wikidata, the URL of the root, e.g. https://www.wikidata.org/wiki/, main page URL, e.g. https://www.wikidata.org/wiki/Wikidata:Main_Page and the API endpoint, e.g. https://www.wikidata.org/w/api.php | requires max_lag and site_iri |
| Comment | No harm in keeping them | We should craft a list of MediaWiki configs we can expose | |
Change 624011 had a related patch set uploaded (by Tonina Zhelyazkova; owner: Tonina Zhelyazkova):
[mediawiki/extensions/WikibaseManifest@master] Add ADR 3 - Manifest Output Format
Change 624011 merged by jenkins-bot:
[mediawiki/extensions/WikibaseManifest@master] Add docs - Manifest Output Format