GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - WP-API/docs: The content for developer.wordpress.org/rest-api

BranchesTags
Open more actions menu

Latest commit

 

History

241 Commits
241 Commits

Folders and files

NameName
Last commit message
Last commit date
bin
bin
 
 
extending-the-rest-api
extending-the-rest-api
 
 
reference
reference
 
 
using-the-rest-api
using-the-rest-api
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
changelog.md
changelog.md
 
 
composer.json
composer.json
 
 
composer.lock
composer.lock
 
 
extending-the-rest-api.md
extending-the-rest-api.md
 
 
frequently-asked-questions.md
frequently-asked-questions.md
 
 
glossary.md
glossary.md
 
 
index.md
index.md
 
 
key-concepts.md
key-concepts.md
 
 
reference.md
reference.md
 
 
requests.md
requests.md
 
 
using-the-rest-api.md
using-the-rest-api.md
 
 

Repository files navigation

API Docs

This repo contains the source for documentation for the API on developer.wordpress.org (DevHub).

Adding/Removing Files

When creating new files, these must be added to the manifest. Run bin/generate-manifest.php to update this.

Removing files also requires regenerating the manifest. After deletion and sync with DevHub, the page also needs to be manually deleted from DevHub.

Refreshing the Templated API Reference

The reference section is created by parsing the output of a site's schema as retrieved from that site's REST API index route. The current method used to generate this approach is as follows:

  • Create a local WordPress environment (always use the current or Release Candidate version of WordPress) using the local environment tool of your choice.
  • Edit /etc/hosts to map the domain example.com to the IP of that WordPress instance, and ensure the site is configured to run at example.com.
  • Run composer install in this project's root directory to install dependencies.
  • Run composer run-script regenerate in this project's root directory to run the asset regeneration script.
  • Use git status and git diff to validate that the files were updated as expected.

About

The content for developer.wordpress.org/rest-api

developer.wordpress.org/rest-api

Resources

Readme
Activity
Custom properties

Stars

127 stars

Watchers

13 watching

Forks

682 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.