Making WordPress.org

Opened 11 months ago

Last modified 4 months ago

#2345 new task

Create an automated workflow for the WP REST API reference.

Reported by: ChopinBach Owned by:
Milestone: Priority: normal
Component: Developer Hub Keywords:


The reference located in the handbook is currently some copy pasta magic. Moving into the future, it will be important to keep the reference up to date and accurate; automation is essential. It will be equally important to look at different versions of the API, as it has been changing quite a bit. There are four primary goals to this plugin:

(1) Produce HTML
(2) Provide a way to add extra human-readable documentation for each field
(3) Handle versioning correctly
(4) Handle any site

To best accommodate these four needs, a JavaScript based browser application will most likely work best. By taking this approach external authentication is not necessary. It will also provide a neat little plugin that other WordPress installations can use to manage their API reference.

I should have an MVP running by Friday, and would love other people's opinions/help. Development will happen here https://github.com/BE-Webdesign/wp-rest-api-reference.

Change History (2)

This ticket was mentioned in Slack in #meta-devhub by jnylen. View the logs.

11 months ago

#2 @rmccue
4 months ago

As a stop-gap, #2968 allows us to start generating the reference into static HTML again. We still want a better reference though.

Note: See TracTickets for help on using tickets.