🚧
Open Data API (API)
ShortURL | Playbook | Assistant
NOTICE
This documentation page is under construction.
Should you want to be notified once it's published, let us know.
For current internal documentation, please visit: [TIOF PLD] Devs [I] API Guidelines ENG v1.0 (only for Project Lockdown members at the moment - Scheduled to be published) https://docs.google.com/document/d/19DcvhEj1f2m3mzuUYFufOPAHtNyqiQ_FHWncqGn85GQ/edit#heading=h.joekn2c04741
- 1.About this module
- 2.The module in Project Lockdown
- 3.General overview of the module
- 4.Accessing the module
- 5.Contributing
The API module is a back end component that is responsible for providing all the necessary interfacing to manipulate Project Lockdown's data.
It also allows for data access from 3rd parties in a number of differet formats.
Back to top
The following diagram showcases how this Module integrates in the project:
Back to top
The following diagram showcases the general design of the API module:
[WIP]
Back to top
To access the API, please visit https://API.ProjectLockdown.world (Status: Under development)
Back to top
The open GitHub Issues can be found here:
Pending tasks (Labels: Module: API + Stage: Ready) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Module%3A+API%22+label%3A%22Stage%3A+Ready%22
Tasks in progress (Labels: Module: API + Stage: In Progress) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Module%3A+API%22+label%3A%22Stage%3A+In+Progress%22
Upcoming tasks that are being prepared (Labels: Module: API + Stage: Not Ready) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Stage%3A+Not+Ready%22+label%3A%22Module%3A+API%22
Back to top
Last modified 9mo ago