Updated Web API Docs "versionadded" entries and Web API Field definitions to include an "added_in" Entry.
Review Request #6680 — Created Dec. 5, 2014 and submitted — Latest diff uploaded
We started adding an "added_in" entry, which tells us in which version a particular field was added, everytime we introduce a new field in a web API resource. It was pretty inconsistant, and some fields never had those entires added in the first place.
Now, all relevant fields in the web API resources have an "added_in" entry, and all releveant resources in the web API docs have a "versionadded" entry with the correct version.
Used git blame, git log, and git tag to find the commit that added each field.
Built the docs.
Diff Revision 5
This is not the most recent revision of the diff. The latest diff is revision 6. See what's changed.
orig
1
2
3
4
5
6
| reviewboard/webapi/resources/base_screenshot.py | |||
|---|---|---|---|
| Revision d6882c22cd4bbbe290832246e37a12b84e9db58e | New Change | ||
| 37 lines | |||
class BaseScreenshotResource(WebAPIResource):
|
|||
| 38 |
"on the Review Board server.", |
38 |
"on the Review Board server.", |
| 39 |
},
|
39 |
},
|
| 40 |
'filename': { |
40 |
'filename': { |
| 41 |
'type': six.text_type, |
41 |
'type': six.text_type, |
| 42 |
'description': "The base file name of the screenshot's image.", |
42 |
'description': "The base file name of the screenshot's image.", |
| 43 |
'added_in': '1.7.10', |
||
| 43 |
},
|
44 |
},
|
| 44 |
'review_url': { |
45 |
'review_url': { |
| 45 |
'type': six.text_type, |
46 |
'type': six.text_type, |
| 46 |
'description': 'The URL to the review UI for this screenshot.', |
47 |
'description': 'The URL to the review UI for this screenshot.', |
| 48 |
'added_in': '1.7.10', |
||
| 47 |
},
|
49 |
},
|
| 48 |
'url': { |
50 |
'url': { |
| 49 |
'type': six.text_type, |
51 |
'type': six.text_type, |
| 50 |
'description': "The URL of the screenshot file. If this is not " |
52 |
'description': "The URL of the screenshot file. If this is not " |
| 51 |
"an absolute URL (for example, if it is just a "
|
53 |
"an absolute URL (for example, if it is just a "
|
| 216 lines | |||
| reviewboard/webapi/resources/base_screenshot_comment.py |
|---|
| reviewboard/webapi/resources/change.py |
|---|
| reviewboard/webapi/resources/default_reviewer.py |
|---|
| reviewboard/webapi/resources/diff.py |
|---|
| reviewboard/webapi/resources/diff_context.py |
|---|
| reviewboard/webapi/resources/diff_file_attachment.py |
|---|
| reviewboard/webapi/resources/draft_diff.py |
|---|
| reviewboard/webapi/resources/draft_file_attachment.py |
|---|
| reviewboard/webapi/resources/draft_filediff.py |
|---|
| reviewboard/webapi/resources/draft_original_file.py |
|---|
| reviewboard/webapi/resources/draft_patched_file.py |
|---|
| reviewboard/webapi/resources/file_attachment.py |
|---|
| reviewboard/webapi/resources/file_attachment_comment.py |
|---|
| reviewboard/webapi/resources/filediff.py |
|---|
| reviewboard/webapi/resources/hosting_service.py |
|---|
| reviewboard/webapi/resources/hosting_service_account.py |
|---|
| reviewboard/webapi/resources/original_file.py |
|---|
| reviewboard/webapi/resources/patched_file.py |
|---|
| reviewboard/webapi/resources/remote_repository.py |
|---|