Skip to content

Changed documentation of Api v3 #6574

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
Merged
merged 6 commits into from
Feb 4, 2020
Merged

Changed documentation of Api v3 #6574

merged 6 commits into from
Feb 4, 2020

Conversation

Blackcipher101
Copy link
Contributor

Fixes #6559

stsewd
stsewd requested changes Jan 23, 2020
View reviewed changes
Copy link
Member

@stsewd stsewd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't look correct. Please check #6559 (comment)

@Blackcipher101
Copy link
Contributor Author

Blackcipher101 commented Jan 23, 2020 •
edited
Loading

Where are the changes needed
If I could get the line number it would be helpful or in place of which URL I have to replace

@Blackcipher101 Blackcipher101 requested a review from stsewd January 23, 2020 14:55
@saadmk11
Copy link
Member

You need to update the API endpoint and also remove the trailing comma from the json from here:
https://github.com/readthedocs/readthedocs.org/blob/master/docs/api/v3.rst#version-update

@Blackcipher101
Copy link
Contributor Author

Blackcipher101 commented Jan 23, 2020 •
edited
Loading

@saadmk11 Should this
https://readthedocs.org/api/v3/projects/pip/versions/ to https://readthedocs.org/api/v3/projects/{project}/versions/{version}

stsewd
stsewd reviewed Jan 27, 2020
View reviewed changes
Copy link
Member

@stsewd stsewd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to change the docs from version update, not version detail, make sure to read the all the thread from the issue.

@Blackcipher101
Copy link
Contributor Author

@stewed I will do the needful

@Blackcipher101 Blackcipher101 requested a review from stsewd January 28, 2020 14:49
stsewd
stsewd requested changes Jan 28, 2020
View reviewed changes
docs/api/v3.rst Outdated
@@ -161,7 +161,7 @@ Project details
},
"_links": {
"_self": "/api/v3/projects/pip/",
"versions": "/api/v3/projects/pip/versions/",
"versions": "/api/v3/project/pip/version/",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you shouldn't change this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

docs/api/v3.rst Outdated
@@ -294,7 +294,7 @@ Versions listing
Version detail
++++++++++++++

.. http:get:: /api/v3/projects/(string:project_slug)/versions/(string:version_slug)/
.. http:get:: /api/v3/projects/{project}/versions/{version}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

neither this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

docs/api/v3.rst Outdated
@@ -346,7 +346,7 @@ Version detail
Version update
++++++++++++++

.. http:patch:: /api/v3/projects/(string:project_slug)/version/(string:version_slug)/
.. http:patch:: /api/v3/projects/{project}/versions/{version}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you shouldn't remove the types

Copy link
Contributor Author

@Blackcipher101 Blackcipher101 Jan 28, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should it go like (string:project_slug)/versions/(string:version_slug)/ or (string:{projects})/versions/(string:{version})/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like the first one

docs/api/v3.rst Outdated
@@ -315,7 +315,7 @@ Version detail
"identifier": "3a6b3995c141c0888af6591a59240ba5db7d9914",
"ref": "19.0.2",
"built": true,
"active": true,
"active": true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this shouldn't change

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

stsewd
stsewd reviewed Feb 3, 2020
View reviewed changes
@Blackcipher101 @stsewd
Update docs/api/v3.rst
66d40e3 
Co-Authored-By: Santos Gallegos <[email protected]>
@stsewd stsewd merged commit 94422d8 into readthedocs:master Feb 4, 2020
@Blackcipher101 Blackcipher101 deleted the patch4 branch February 5, 2020 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stsewd stsewd stsewd approved these changes

@agjohnson agjohnson Awaiting requested review from agjohnson

@humitos humitos Awaiting requested review from humitos

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

v3 api version-update method not working
3 participants
@Blackcipher101 @saadmk11 @stsewd