Project description in the API

readthedocs / readthedocs.org

The source code that powers readthedocs.org

https://readthedocs.org/

MIT License

8.04k stars 3.58k forks source link

Project description in the API #7352

Open nijel opened 4 years ago

nijel commented 4 years ago

Details

Read the Docs project URL: https://readthedocs.org/projects/weblate/

Expected Result

The projects API doesn't include project description right now. I'm not sure how important that is, but it can be set using the web interface, but not by API.

Actual Result

The description field is not present int https://docs.readthedocs.io/en/stable/api/v3.html#projects

nijel commented 4 years ago

Ah, I just noticed #3689, so this probably doesn't make sense to include when the field is planned for removal.

stsewd commented 4 years ago

@nijel we are changing directions and we are not going to remove it, but make it shorted and not support rst as we used to.

nijel commented 4 years ago

Okay, then it probably still makes sense to include it in the API.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

htech9 commented 1 month ago

@nijel do have any plan to reopen your PR at [https://github.com/readthedocs/readthedocs.org/pull/7353]() to potentially clear this old issue ?

nijel commented 1 month ago

Sure I can, but what has happened to https://github.com/readthedocs/readthedocs.org/issues/3689?

PS: It is now at https://github.com/readthedocs/readthedocs.org/pull/11610