Last modified: 2013-12-03 20:09:26 UTC

Wikimedia Bugzilla is closed!

Wikimedia has migrated from Bugzilla to Phabricator. Bug reports should be created and updated in Wikimedia Phabricator instead. Please create an account in Phabricator and add your Bugzilla email address to it.
Wikimedia Bugzilla is read-only. If you try to edit or create any bug report in Bugzilla you will be shown an intentional error message.
In order to access the Phabricator task corresponding to a Bugzilla report, just remove "static-" from its URL.
You could still run searches in Bugzilla or access your list of votes but bug reports will obviously not be up-to-date in Bugzilla.
Bug 56621 - Properly document the web API interface
Properly document the web API interface
Status: NEW
Product: Parsoid
Classification: Unclassified
Web API (Other open bugs)
unspecified
All All
: Normal enhancement
: ---
Assigned To: Gabriel Wicke
: easy
Depends on:
Blocks: documentation
  Show dependency treegraph
 
Reported: 2013-11-05 17:02 UTC by Gabriel Wicke
Modified: 2013-12-03 20:09 UTC (History)
1 user (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Gabriel Wicke 2013-11-05 17:02:53 UTC
The web API was cleaned up in https://gerrit.wikimedia.org/r/#/c/91321/. We should document this both on the landing page at / and https://www.mediawiki.org/wiki/Parsoid.

GET /prefix/page -- works just as it does now. No wikitext passed in.
POST /prefix/{page} -- with page optional.
    - if "wt" is provided, convert wt2html. "body" flag to return just
      the body
    - if "html" is provided, convert html2wt ("content" works too for bc)
Comment 1 Gabriel Wicke 2013-11-05 17:36:34 UTC
On-wiki documentation mostly done: https://www.mediawiki.org/wiki/Parsoid#The_Parsoid_web_API
Comment 2 Gabriel Wicke 2013-12-03 20:09:26 UTC
Lowering prio to normal, as this is pretty much done.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links