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.

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

Replace "PROJECT" with project object #6878

Merged
merged 6 commits into from May 7, 2020

Conversation

KengoTODA
Copy link
Contributor

@KengoTODA KengoTODA commented Apr 8, 2020

close #6745

To make the document intuitive, replace "PROJECT" with project object.

Copy link
Member

@stsewd stsewd left a comment

Thanks, CI is failing because it expects to be a valid json. I think is fine to just put all fields from project, and add a paragraph saying results is an array of :http:get:`/api/v2/project/(int:id)/`

@KengoTODA
Copy link
Contributor Author

@KengoTODA KengoTODA commented Apr 9, 2020

OK but can I use :http:get:/api/v3/projects/(string:project_slug)/` instead of v2?

https://docs.readthedocs.io/en/stable/api/v3.html#get--api-v3-projects-(string-project_slug)-

@stsewd
Copy link
Member

@stsewd stsewd commented Apr 9, 2020

OK but can I use :http:get:/api/v3/projects/(string:project_slug)/` instead of v2?

Yes, my mistake!

docs/api/v3.rst Outdated Show resolved Hide resolved
docs/api/v3.rst Show resolved Hide resolved
stsewd
stsewd approved these changes May 7, 2020
Copy link
Member

@stsewd stsewd left a comment

@KengoTODA I have pushed changes on how to use the :http:get: role. Everything else looks good, thanks!

@stsewd stsewd merged commit 35b5ca2 into readthedocs:master May 7, 2020
2 checks passed
@KengoTODA KengoTODA deleted the KengoTODA-patch-1 branch May 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants