Addons: consider adding subprojects-related data to API response - Githubissues

readthedocs / readthedocs.org

The source code that powers readthedocs.org

https://readthedocs.org/

MIT License

7.99k stars 3.58k forks source link

Addons: consider adding subprojects-related data to API response #11500

Open humitos opened 1 month ago

humitos commented 1 month ago

We recently talk about the following ideas:

Create a landing page that exposes all the sub-projects of it
Link to the parent project from the documentation of the sub-project (maybe from a breadcrumbs menu)
Link to all the siblings projects from a sub-project

In case we want to move forward with this idea, we would need to include the following fields to the API response:

projects.subprojects
projects.parent
projects.siblings

I haven't thought too much about this, but I wanted to open this issue so I don't forget about this idea.

stsewd commented 1 month ago

We should just make sure we check for permissions. Also, we already have the /suprojects and /superproject endpoints.