WordPress.org

Making WordPress.org

Opened 17 months ago

Closed 4 months ago

#2345 closed enhancement (maybelater)

Create an automated workflow for the WP REST API reference.

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

Description

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 (7)

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


17 months ago

#2 @rmccue
10 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.

#3 follow-up: @obenland
4 months ago

  • Type changed from task to enhancement

@ChopinBach What's the latest on your plugin?

#4 in reply to: ↑ 3 ; follow-up: @ChopinBach
4 months ago

Replying to obenland:

@ChopinBach What's the latest on your plugin?

Hi @obenland,

Great question, and pleasant surprise! I somewhat forgot about this project to be honest. I can get back to it though, the current plugin is not a good approach towards the problem anyways, so I would probably revamp it for something better. Is there reinvigorated interest in pushing this forward?

#5 in reply to: ↑ 4 ; follow-up: @obenland
4 months ago

I'm just trying to scrub this Trac and fix/close as many tickets as possible. :)

Is this a maybelater then?

#6 in reply to: ↑ 5 @ChopinBach
4 months ago

Replying to obenland:

I'm just trying to scrub this Trac and fix/close as many tickets as possible. :)

Is this a maybelater then?

Most likely yeah. When I work on it, I can update the status back to something else?

#7 @obenland
4 months ago

  • Resolution set to maybelater
  • Status changed from new to closed

Absolutely. Every ticket can be reopened.
Thanks!

Note: See TracTickets for help on using tickets.