Q1. What is the problem that you are trying to solve?
There is no help section that details the API endpoint. As a developer I cannot contribute to passbolt or integrate passbolt with my other systems without it.
Q2 - Who is impacted?
Developers
Q3 - Why is it important and/or urgent?
Integration is key for system adoption. It will also help new developers to join the project.
Q4 - What is your proposed solution? (optional)
Use swagger or something similar to generate an API doc. In v1 we started working on documenting the API with Swagger. So if you navigate to https://yourdomain/api/swagger.json you’ll see that the models are “done”. We still need to go through the controllers, and then we’ll be able to generate live docs like http://petstore.swagger.io/ .
We are currently working on the launch of passbolt pro, which will contain tags, import, export and some other goodies. The API documentation will come after. Thanks for your patience, we’ll update the roadmap to reflect these new timelines.
@remy I am also keen to utilize the API. I appreciate that your efforts are on the Pro release at the moment but I wonder if there are any pointers that you can give with regards to getting started with using the API. For example what the endpoint URL is and how to authenticate the API request.
It seems that GET /resources.json returns all secrets that the user can access. Is there a way to search by keyword and return only the resources whose name matches the keyword?