Making WordPress.org

#6872 closed enhancement (maybelater)

Update WordPress.org API page for Version Check to show Release Candidates

Reported by: champsupertramp's profile champsupertramp Owned by:
Milestone: Priority: low
Component: WordPress.org Site Keywords:
Cc:

Description

I've asked an API endpoint for us to check for the WP.org Release Candidates details.

@otto42 has provided this URL with an extra parameter to show RC/Beta versions.
https://api.wordpress.org/core/version-check/1.7/?channel=beta

Please update this section:
https://codex.wordpress.org/WordPress.org_API#Version_Check

Example:
WordPress Version Checker.

https://api.wordpress.org/core/version-check/1.6/ (PHP serialized)
https://api.wordpress.org/core/version-check/1.7/ (JSON encoded)
https://api.wordpress.org/core/version-check/1.7/?channel=beta ( shows all beta/release candidates )

Change History (7)

#1 @champsupertramp
16 months ago

  • Summary changed from Update WordPres.org API page for Version Check to show Release Candidates to Update WordPress.org API page for Version Check to show Release Candidates

#2 @dd32
16 months ago

  • Priority changed from normal to low
  • Summary changed from Update WordPress.org API page for Version Check to show Release Candidates to Update WordPres.org API page for Version Check to show Release Candidates

The WordPress.org APIs are not currently documented officially, as they're only intended for internal WordPress usage, and are subject to change (although likely wouldn't, as they're used by WordPress). The Codex is just the user-contributed documentation.

The only one intended for external usage is the Stable-check API.

Ideally we'd remove that codex page and replace it with an official documented version on developer.wordpress.org.

#3 @dd32
16 months ago

  • Summary changed from Update WordPres.org API page for Version Check to show Release Candidates to Update WordPress.org API page for Version Check to show Release Candidates

#4 @champsupertramp
16 months ago

Hi @dd32

Do you have a timeline for when this official documentation for this page will be created? It will be helpful to others if this parameter will be shared as the API Endpoint for Version Check is already exposed and added to the documentation. Others may find it helpful especially those who don't have access to the Slack community.

Thank you

This ticket was mentioned in Slack in #meta by tellyworth. View the logs.


16 months ago

This ticket was mentioned in Slack in #meta by sereedmedia. View the logs.


15 months ago

#7 @SeReedMedia
15 months ago

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

From @otto42 in the #meta meeting: "For there to be API documentation, their first need to be a plan for the API and a method of long-term support around providing that documentation stayed up to date.

Currently no such plan exists, as the API is meant only really for WordPress core and WordPress.org to use. We don't mind other people using it, but any non-official uses of it are not supported and could change at any time.

So documentation for it is unlikely, because there isn't any official method of support for it yet, and no real plan to have such."

Note: See TracTickets for help on using tickets.