-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README: fix link + minor adjustments (#21)
Slight adjustments to phrasing, capitalization, punctuation and whitespace.
- Loading branch information
1 parent
e20497e
commit 2c16bda
Showing
1 changed file
with
12 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,21 @@ | ||
# entityshape | ||
An api to compare a wikidata item with an entityschema | ||
|
||
This api is available at http://entityshape.toolforge.org/api. The api requires 3 parameters to return a result as follows: | ||
An API to compare a Wikidata item with an EntitySchema. | ||
The API is available at <http://entityshape.toolforge.org/api>. | ||
|
||
The API requires the following parameters to be provided with requests: | ||
1. __language__: e.g. _en_ the language to return property names in | ||
2. __entity__: e.g. _Q42_ the wikidata entity to check | ||
3. __entityschema__: e.g. _E14_ the entityschema to check against | ||
2. __entity__: e.g. _Q42_ the Wikidata entity to check | ||
3. __entityschema__: e.g. _E14_ the EntitySchema to check against | ||
|
||
The api returns a json object containing the following: | ||
The API returns a JSON object containing the following: | ||
1. __error__: details of any error which may have occurred | ||
2. __schema__: the entityschema checked against | ||
3. __name__: the display name of the entityschema | ||
2. __schema__: the EntitySchema checked against | ||
3. __name__: the display name of the EntitySchema | ||
4. __validity__: the validity of the schema (currently unused) | ||
5. __properties__: a json object describing the validity of each property in the entity | ||
6. __statements__: a json object describing the validity of each statement in the entity | ||
|
||
This repository also contains the source code for the user script at https://www.wikidata.org/w/User:Teester/EntityShape.js which allow use of this api on wikidata entity pages | ||
This repository also contains the source code for the user script at | ||
<https://www.wikidata.org/wiki/User:Teester/EntityShape.js>, | ||
which allows use of this API on Wikidata entity pages. |