mwoffliner icon indicating copy to clipboard operation
mwoffliner copied to clipboard

Document the API we rely on

Open kelson42 opened this issue 4 years ago • 4 comments

We need to better understand on which API we rely on to do a proper software architecture. Something has started here https://species.wikimedia.org/api/rest_v1/#/Mobile but we need to complete and get things in a form of a table.

The information for which API is:

  • The URL scheme (with the dynamic part)
  • The nature output
  • A description of the output
  • The software delivering it
  • Where is this available (local Parsoid, restbase, old mediawiki, new mediawiki)
  • Why we need it

Ideally they should be grouped by nature.

It seems the current MWoffliner "parse wikitext", this should not happen and this table should really help to understand why.

kelson42 avatar Jun 16 '20 14:06 kelson42

Process is going there https://docs.google.com/spreadsheets/d/1oNX9XAILHemks4BW9mXOLb4gnpn7w-j_VBMXwastNY0/edit#gid=0

midik avatar Jun 21 '20 20:06 midik

@midik Looks a good start. Would you be able to move it in the wiki (if you struggle with the table, a coherent list of bullet points shoudl be good enough). It seems the local instances (parsoid) is missing. Ping me we your effort is over.

kelson42 avatar Jun 22 '20 06:06 kelson42

This issue has been automatically marked as stale because it has not had recent activity. It will be now be reviewed manually. Thank you for your contributions.

stale[bot] avatar Aug 21 '20 20:08 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be now be reviewed manually. Thank you for your contributions.

stale[bot] avatar Feb 14 '21 19:02 stale[bot]

PCS docs might be used as a reference here: https://www.mediawiki.org/wiki/Page_Content_Service

VadimKovalenkoSNF avatar Jul 21 '23 14:07 VadimKovalenkoSNF

Basic documentation available at https://github.com/openzim/mwoffliner/wiki/API-end%E2%80%90points. To be extended

kelson42 avatar Sep 30 '23 14:09 kelson42