openzim / mwoffliner

Mediawiki scraper: all your wiki articles in one highly compressed ZIM file
https://www.npmjs.com/package/mwoffliner
GNU General Public License v3.0
275 stars 72 forks source link

mwoffliner api calls #2018

Open tim-moody opened 4 months ago

tim-moody commented 4 months ago

https://github.com/openzim/mwoffliner/wiki/API-end%E2%80%90points lists 5 endpoints, 3 for mediawiki including VisualEditor and ActionParse currently implemented, and RestApi, which I believe is new to the current dev version.

VisualEditor and ActionParse are really both the same api, just with different parameters, and are both normally used when the target is mediawiki in my experience.

https://github.com/openzim/mwoffliner/wiki/Frequently-Asked-Questions mentions the runtime parameter --forceRender as a means of choosing an api. This parameter is also described in https://github.com/openzim/mwoffliner/blob/main/src/parameterList.ts, which gives 3 values allowed: VisualEditor, WikimediaDesktop, and WikimediaMobile. (This file supplies the help for mwoffliner I believe.)

So my question is, can I use --forceRender to cause the RestApi to be used and if so what value should I use? The obvious answer would be RestApi (or restapi as the others are all lowercase), but I didn't find this in the code and when I tried it I still got the action api.

kelson42 commented 4 months ago

@tim-moody Have you tried the --help option?

tim-moody commented 4 months ago

--help prints the contents of https://github.com/openzim/mwoffliner/blob/main/src/parameterList.ts cited above.

kelson42 commented 4 months ago

Yes, and you have the list of accepted value of --forcerender

tim-moody commented 4 months ago

True, and restapi is not among them, which I took to be an error. So if the --help is accurate and there is no value of --forcerender to cause mwoffliner use restapi, under what circumstances does mwoffliner use the restapi and is there any way to force it to do so?