Add python examples for API v3 Documentation #6487
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Issue #5935 |
stsewd
reviewed
Jan 6, 2020
docs/api/v3.rst
Outdated
| TOKEN = '<token>' | ||
| HEADERS = {'Authorization': 'token {}'.format(TOKEN)} | ||
| response = requests.get(URL, headers=HEADERS) | ||
| print(response.text) |
There was a problem hiding this comment.
Suggested change
| print(response.text) | |
| print(response.json()) |
docs/api/v3.rst
Outdated
| import requests | ||
| URL = 'https://readthedocs.org/api/v3/projects/' | ||
| TOKEN = '<token>' | ||
| HEADERS = {'Authorization': 'token {}'.format(TOKEN)} |
There was a problem hiding this comment.
Suggested change
| HEADERS = {'Authorization': 'token {}'.format(TOKEN)} | |
| HEADERS = {'Authorization': f'token {TOKEN}'} |
docs/api/v3.rst
Outdated
| import requests | ||
| URL = 'https://readthedocs.org/api/v3/projects/pip/' | ||
| TOKEN = '<token>' | ||
| HEADERS = {'Authorization': 'token {}'.format(TOKEN)} |
There was a problem hiding this comment.
Suggested change
| HEADERS = {'Authorization': 'token {}'.format(TOKEN)} | |
| HEADERS = {'Authorization': f'token {TOKEN}'} |
docs/api/v3.rst
Outdated
| TOKEN = '<token>' | ||
| HEADERS = {'Authorization': 'token {}'.format(TOKEN)} | ||
| response = requests.get(URL, headers=HEADERS) | ||
| print(response.text) |
There was a problem hiding this comment.
Suggested change
| print(response.text) | |
| print(response.json()) |
docs/api/v3.rst
Outdated
| import json | ||
| URL = 'https://readthedocs.org/api/v3/projects/' | ||
| TOKEN = '<token>' | ||
| HEADERS = {'Authorization' : 'token {}'.format(TOKEN)} |
There was a problem hiding this comment.
Suggested change
| HEADERS = {'Authorization' : 'token {}'.format(TOKEN)} | |
| HEADERS = {'Authorization' : f'token {TOKEN}'} |
docs/api/v3.rst
Outdated
| TOKEN = '<token>' | ||
| HEADERS = {'Authorization': 'token {}'.format(TOKEN)} | ||
| response = requests.get(URL, headers=HEADERS) | ||
| print(response.text) |
There was a problem hiding this comment.
Suggested change
| print(response.text) | |
| print(response.json()) |
docs/api/v3.rst
Outdated
| HEADERS = {'Authorization' : 'token {}'.format(TOKEN)} | ||
| data = json.load(open('body.json', 'rb')) | ||
| response = requests.post(URL, | ||
| json = data, headers = HEADERS) |
docs/api/v3.rst
Outdated
| import json | ||
| URL = 'https://readthedocs.org/api/v3/projects/pip/redirects/' | ||
| TOKEN = '<token>' | ||
| HEADERS = {'Authorization' : 'token {}'.format(TOKEN)} |
There was a problem hiding this comment.
Suggested change
| HEADERS = {'Authorization' : 'token {}'.format(TOKEN)} | |
| HEADERS = {'Authorization' : f'token {TOKEN}'} |
docs/api/v3.rst
Outdated
| data = json.load(open('body.json', 'rb')) | ||
| response = requests.post(URL, | ||
| json = data, headers = HEADERS) | ||
| print(response.text) |
There was a problem hiding this comment.
Suggested change
| print(response.text) | |
| print(response.json()) |
docs/conf.py
Outdated
| @@ -39,6 +39,7 @@ def get_version(): | |||
| 'recommonmark', | |||
| 'notfound.extension', | |||
| 'sphinx_search.extension', | |||
| 'sphinx_tabs.tabs', | |||
There was a problem hiding this comment.
We already have this extension listed above ^
Suggested change
| 'sphinx_tabs.tabs', |
stsewd
reviewed
Jan 13, 2020
docs/api/v3.rst
Outdated
| data = json.load(open('body.json', 'rb')) | ||
| response = requests.post( | ||
| URL, | ||
| json = data, |
There was a problem hiding this comment.
Suggested change
| json = data, | |
| json=data, |
stsewd
reviewed
Jan 14, 2020
docs/api/v3.rst
Outdated
| @@ -936,11 +1231,22 @@ Environment Variable delete | |||
|
|
|||
| **Example request**: | |||
|
|
|||
| .. sourcecode:: bash | |||
| .. tabs:: | |||
There was a problem hiding this comment.
Suggested change
| .. tabs:: | |
| .. tabs:: |
There was a problem hiding this comment.
sorry about that, must have missed the last one while checking. I fixed it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.