search

MaRDI4NFDI / portal-compose

docker-composer repo for mardi
https://portal.mardi4nfdi.de
GNU General Public License v3.0
3 stars 1 forks source link

[Epic][Draft] Knowledge Graph API #348

Closed eloiferrer closed 7 months ago

eloiferrer commented 1 year ago

Epic description in words: Knowledge Graph API should be available to all MaRDI members.

Main functionality is to read, insert, update and delete entities in the knowledge graph. This functionality is available through the wikibase API: https://www.mediawiki.org/wiki/Wikibase/API Documentation should be adapted to MaRDI for the most used functions (e.g. wbgetentities, wbeditentity and wbsearchentities). Documentation could be expanded with specific examples from the mathematical field.

Current plan is to use Wikibase-REST-API for the definition of endpoints and for examples. A fallback plan can be to use the Wikibase API.

Corresponding Milestones: M-TA5-A3 API access possible. After 18 months read, insert, update and delete is possible via APIs allowing for a fast population of the MaRDI knowledge graph.

Epic issues:

1. Locally check the wikibase-rest-api and change some necessary parameters in the open-api-documentation (add an example, change the text in the main-page) (Johannes) 2. Check if the existing endpoints in wikibase-rest-api are functional and suit all cases (Eloi) 3. Integrate Rest API to deployment: Version check for MediaWiki, sync if necessary, so it contains Wikibase API. Make mirror repository folder of https://github.com/wikimedia/Wikibase/tree/master/repo/rest-api, overwrite our current Build-Process with the Rest-API folder. (Johannes) 4. Activate Rest API internally our MediaWiki in Portal (Johannes) 5. Define our Knowledge Graph API and set up examples, specify endpoints and so on and implement it in our overwrite repository. (Eloi) 7. Activate the Knowledge Graph API publicly: forward public endpoint, make preceding security checks before (Eloi, Johannes) **Related bugs**: - **Epic acceptance criteria**: - [ ] API documentation published in the portal **Checklist for this epic**: - [ ] the main MaRDI project has been assigned as project - [ ] report has been created
Hyper-Node commented 1 year ago

https://github.com/wikimedia/Wikibase/tree/master/repo/rest-api

Documentation and definition of Wikibase-Rest API.

To have a cross-reference here to Portal-API which is related in future: https://github.com/MaRDI4NFDI/portal-compose/issues/337

Hyper-Node commented 7 months ago

not recent, only planning draft.