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

Merged
merged 6 commits into from
Feb 4, 2020
Merged

Changed documentation of Api v3 #6574

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
aaca60e
Changed documentation of Api v3
Blackcipher101 Jan 23, 2020
b584b76
Did the requrired changes
Blackcipher101 Jan 26, 2020
82ab4fa
made the changes in version update documentationi
Blackcipher101 Jan 28, 2020
80688e3
Reverted unwanted changes
Blackcipher101 Jan 28, 2020
f27082d
Update v3.rst
Blackcipher101 Feb 3, 2020
66d40e3
Update docs/api/v3.rst
Blackcipher101 Feb 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api/v3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

"builds": "/api/v3/projects/pip/builds/",
"subprojects": "/api/v3/projects/pip/subprojects/",
"superproject": "/api/v3/projects/pip/superproject/",
Expand Down Expand Up @@ -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


Retrieve details of a single version.

Expand All @@ -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

"type": "tag",
"last_build": "{BUILD}",
"downloads": {
Expand Down Expand Up @@ -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


Update a version.

Expand Down