Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Project description in the API #7352

Open
nijel opened this issue Aug 3, 2020 · 6 comments · May be fixed by #11610
Open

Project description in the API #7352

nijel opened this issue Aug 3, 2020 · 6 comments · May be fixed by #11610
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code

Comments

@nijel
Copy link
Contributor

nijel commented Aug 3, 2020

Details

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 added a commit to nijel/readthedocs.org that referenced this issue Aug 3, 2020
@nijel
API: Include project description
4ef02a1 
Fixes readthedocs#7352
@nijel nijel mentioned this issue Aug 3, 2020
Closed
@nijel
Copy link
Contributor Author

nijel commented Aug 3, 2020

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

@nijel nijel closed this as completed Aug 3, 2020
@stsewd
Copy link
Member

stsewd commented Aug 3, 2020

@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
Copy link
Contributor Author

nijel commented Aug 3, 2020

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

@nijel nijel reopened this Aug 3, 2020
@stsewd stsewd added the Improvement Minor improvement to code label Aug 6, 2020
@stale
Copy link

stale bot commented Sep 21, 2020

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.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Sep 21, 2020
@stsewd stsewd added Accepted Accepted issue on our roadmap and removed Status: stale Issue will be considered inactive soon labels Sep 21, 2020
@htech9
Copy link

htech9 commented Sep 22, 2024

@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
Copy link
Contributor Author

nijel commented Sep 23, 2024 •
edited
Loading

Sure I can, but what has happened to #3689?

PS: It is now at #11610

nijel added a commit to nijel/readthedocs.org that referenced this issue Sep 23, 2024
@nijel
API: Include project description
5dfb48b 
Fixes readthedocs#7352
@nijel nijel linked a pull request Sep 23, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Projects
None yet
Milestone
No milestone
3 participants
@nijel @stsewd @htech9