Developer Network™ Description
Make the Webservices API accessible to users and machines through comprehensive documentation (in the current documentation environment
Updated: 27-10-2025
Project Initiative Document
Objectives
The objectives of this project are the following:
1. Documentation: Make the Webservices API accessible to users and machines through comprehensive documentation (in the current documentation environment).
2. Testing: Be able to test existing API endpoints.
3. Examples: Provide examples of how the API can be used. Including the different ways the API can be called with payloads.
4. Standards: Deliver a standard that the documentation must meet.
5. Agenda: Deliver a work agenda regarding necessary improvements and desired extensions.
Main results
The main results of this project are the following:
Objective 1
1.1 Updated documentation of the Joomla Webservices API.
1.2 Ideally utilize different documentation perspectives.
1.3 Integrate the documentation into the current documentation environment (Docusaurus).
1.4 The documentation adheres to the chosen standard.
Objective 2
2.1 Ready-to-use test software (probably PHP scripts) to be able to test the API endpoints.
2.2 Test instructions.
2.3 Make the software available.
Objective 3
3.1 Inventory of existing API endpoints.
3.2 Collection of payloads to test the endpoints. When applicable, provide several payloads per endpoint.
Objective 4
4.1 Selected standard for the API endpoints. May be adopted from another project.
4.2 Selected standard for the API documentation. May be adopted from another project.
Objective 5
5.1 Inventory of existing bugs. Results of testing.
5.2 Inventory of desired API endpoint extensions.
Secondary results
6.1 Organize the project
6.2 Report on the project
Approach
Project Roles
Project owner:
Project lead:
Reporting pathway:
Decision making process:
Relation with other projects and persons
Other projects
1. Build MCP servers to enable AI usage - with WCAG in mind (lead: David Jardin)
2. Improve webservices to enable better machine-to-machine communication (lead: Martin Kopp)
3. Documentation project (lead: Herman Peeren)
Other (groups of) people
1. Developers of the webservices API
- Harald Leithner
Stakeholders
Gathering individuals interested in using the Joomla Webservices API and developing its documentation.
Working Method
Testing the API endpoints is the primary method to determine what needs to be documented.
Test Software
Accessible via a website?
User provides API configuration and can start testing.
Documentation Software
Write (or have written) the concept texts in a dedicated Docusaurus project and later incorporate them into the documentation site via pull requests.
Progress
Update of 27-10-2025
1.3 Started an initial version of the documentation in Docusaurus.
2.1 Initial version of the software is running.
3.1 All the endpoints from the Postman collection are now included.
3.2 All the endpoints under 3.1 now have one payload example.
6.1 Initial draft of the project plan.
Meetings
17-11-2025: Project board (Sigrid, Benjemin, Arend-Henk, Carst)
Discussion points:
1. Project roles
2. Related projects and initiatives
Open issues
1. Is there something like a project overview of all Joomla Projects? To find related projects and initiatives.