Summary

Move API resource version handling into the API doc generator.

Review Request #8770 — Created Feb. 20, 2017 and submitted Feb. 21, 2017, 10:31 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-2.5.x

Bugs

Depends On

Commit

28de153...

Reviewers

Groups

reviewboard

People

Description

We were keeping information on resource versioning (when it was added,
deprecated, removed) in two places: In the resource and in the doc file.
While we haven't had any inconsistencies, it doesn't make sense to have
this in two places when we can easily generate what we want in the docs
generator based on the metadata on the resources.

This adds support in the API doc generator to output the versioning
information, and removes the manual information from each of the files,
simplifying them.

It also introduces "item_resource_" and "list_resource_" prefixes for
the "added_in", etc. versioning fields, for the cases (one case,
currently) where lists and items weren't added in the same version.

Testing Done

Built the docs and checked that all generated docs with resources
referencing version information had the information listed under
the resource name.

Verified that each resource and each doc file had matching version
information before removing from the files.

Issues

Description	From	Last Updated
Col: 38 E127 continuation line over-indented for visual indent	reviewbot	Feb. 20, 2017, 9:13 p.m.

Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/resources/hosting_service_account.py
    docs/manual/_ext/webapidocs.py

Ignored Files:
    docs/manual/webapi/2.0/resources/change-list.rst
    docs/manual/webapi/2.0/resources/web-hook-list.rst
    docs/manual/webapi/2.0/resources/review-reply-file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/review-reply-file-attachment-comment.rst
    docs/manual/webapi/2.0/resources/draft-diff-list.rst
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/diff-file-attachment-list.rst
    docs/manual/webapi/2.0/resources/diff-context.rst
    docs/manual/webapi/2.0/resources/file-attachment-list.rst
    docs/manual/webapi/2.0/resources/change.rst
    docs/manual/webapi/2.0/resources/file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/validate-diff.rst
    docs/manual/webapi/2.0/resources/diff-file-attachment.rst
    docs/manual/webapi/2.0/resources/draft-file-diff-list.rst
    docs/manual/webapi/2.0/resources/original-file.rst
    docs/manual/webapi/2.0/resources/web-hook.rst
    docs/manual/webapi/2.0/resources/api-token-list.rst
    docs/manual/webapi/2.0/resources/draft-original-file.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/hosting-service-account.rst
    docs/manual/webapi/2.0/resources/validation.rst
    docs/manual/webapi/2.0/resources/remote-repository-list.rst
    docs/manual/webapi/2.0/resources/hosting-service-account-list.rst
    docs/manual/webapi/2.0/resources/default-reviewer-list.rst
    docs/manual/webapi/2.0/resources/remote-repository.rst
    docs/manual/webapi/2.0/resources/patched-file.rst
    docs/manual/webapi/2.0/resources/draft-file-attachment.rst
    docs/manual/webapi/2.0/resources/review-file-attachment-comment.rst
    docs/manual/webapi/2.0/resources/repository-commits.rst
    docs/manual/webapi/2.0/resources/default-reviewer.rst
    docs/manual/webapi/2.0/resources/draft-file-diff.rst
    docs/manual/webapi/2.0/resources/draft-file-attachment-list.rst
    docs/manual/webapi/2.0/resources/search.rst
    docs/manual/webapi/2.0/resources/file-attachment.rst
    docs/manual/webapi/2.0/resources/draft-diff.rst
    docs/manual/webapi/2.0/resources/draft-patched-file.rst
    docs/manual/webapi/2.0/resources/review-file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/api-token.rst
    docs/manual/webapi/2.0/resources/repository-branches.rst



Tool: Pyflakes
Processed Files:
    reviewboard/webapi/resources/hosting_service_account.py
    docs/manual/_ext/webapidocs.py

Ignored Files:
    docs/manual/webapi/2.0/resources/change-list.rst
    docs/manual/webapi/2.0/resources/web-hook-list.rst
    docs/manual/webapi/2.0/resources/review-reply-file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/review-reply-file-attachment-comment.rst
    docs/manual/webapi/2.0/resources/draft-diff-list.rst
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/diff-file-attachment-list.rst
    docs/manual/webapi/2.0/resources/diff-context.rst
    docs/manual/webapi/2.0/resources/file-attachment-list.rst
    docs/manual/webapi/2.0/resources/change.rst
    docs/manual/webapi/2.0/resources/file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/validate-diff.rst
    docs/manual/webapi/2.0/resources/diff-file-attachment.rst
    docs/manual/webapi/2.0/resources/draft-file-diff-list.rst
    docs/manual/webapi/2.0/resources/original-file.rst
    docs/manual/webapi/2.0/resources/web-hook.rst
    docs/manual/webapi/2.0/resources/api-token-list.rst
    docs/manual/webapi/2.0/resources/draft-original-file.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/hosting-service-account.rst
    docs/manual/webapi/2.0/resources/validation.rst
    docs/manual/webapi/2.0/resources/remote-repository-list.rst
    docs/manual/webapi/2.0/resources/hosting-service-account-list.rst
    docs/manual/webapi/2.0/resources/default-reviewer-list.rst
    docs/manual/webapi/2.0/resources/remote-repository.rst
    docs/manual/webapi/2.0/resources/patched-file.rst
    docs/manual/webapi/2.0/resources/draft-file-attachment.rst
    docs/manual/webapi/2.0/resources/review-file-attachment-comment.rst
    docs/manual/webapi/2.0/resources/repository-commits.rst
    docs/manual/webapi/2.0/resources/default-reviewer.rst
    docs/manual/webapi/2.0/resources/draft-file-diff.rst
    docs/manual/webapi/2.0/resources/draft-file-attachment-list.rst
    docs/manual/webapi/2.0/resources/search.rst
    docs/manual/webapi/2.0/resources/file-attachment.rst
    docs/manual/webapi/2.0/resources/draft-diff.rst
    docs/manual/webapi/2.0/resources/draft-patched-file.rst
    docs/manual/webapi/2.0/resources/review-file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/api-token.rst
    docs/manual/webapi/2.0/resources/repository-branches.rst

docs/manual/_ext/webapidocs.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 38
 E127 continuation line over-indented for visual indent
```

Change Summary:

Fixed an alignment issue.

Commit:

a7da0af4033da23113422925ced3ff43efb97690

28de153d7c7544d478e6690f2fcbe3f8e3b508ea

Diff:

Revision 2 (+25 -79)

Show changes

	docs/manual/_ext/webapidocs.py
	docs/manual/webapi/2.0/resources/api-token.rst
	docs/manual/webapi/2.0/resources/api-token-list.rst
	docs/manual/webapi/2.0/resources/change.rst
	docs/manual/webapi/2.0/resources/change-list.rst
	docs/manual/webapi/2.0/resources/default-reviewer.rst
	docs/manual/webapi/2.0/resources/default-reviewer-list.rst
	docs/manual/webapi/2.0/resources/diff-context.rst
	33 more

Tool: Pyflakes
Processed Files:
    reviewboard/webapi/resources/hosting_service_account.py
    docs/manual/_ext/webapidocs.py

Ignored Files:
    docs/manual/webapi/2.0/resources/change-list.rst
    docs/manual/webapi/2.0/resources/web-hook-list.rst
    docs/manual/webapi/2.0/resources/review-reply-file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/review-reply-file-attachment-comment.rst
    docs/manual/webapi/2.0/resources/draft-diff-list.rst
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/diff-file-attachment-list.rst
    docs/manual/webapi/2.0/resources/diff-context.rst
    docs/manual/webapi/2.0/resources/file-attachment-list.rst
    docs/manual/webapi/2.0/resources/change.rst
    docs/manual/webapi/2.0/resources/file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/validate-diff.rst
    docs/manual/webapi/2.0/resources/diff-file-attachment.rst
    docs/manual/webapi/2.0/resources/draft-file-diff-list.rst
    docs/manual/webapi/2.0/resources/original-file.rst
    docs/manual/webapi/2.0/resources/web-hook.rst
    docs/manual/webapi/2.0/resources/api-token-list.rst
    docs/manual/webapi/2.0/resources/draft-original-file.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/hosting-service-account.rst
    docs/manual/webapi/2.0/resources/validation.rst
    docs/manual/webapi/2.0/resources/remote-repository-list.rst
    docs/manual/webapi/2.0/resources/hosting-service-account-list.rst
    docs/manual/webapi/2.0/resources/default-reviewer-list.rst
    docs/manual/webapi/2.0/resources/remote-repository.rst
    docs/manual/webapi/2.0/resources/patched-file.rst
    docs/manual/webapi/2.0/resources/draft-file-attachment.rst
    docs/manual/webapi/2.0/resources/review-file-attachment-comment.rst
    docs/manual/webapi/2.0/resources/repository-commits.rst
    docs/manual/webapi/2.0/resources/default-reviewer.rst
    docs/manual/webapi/2.0/resources/draft-file-diff.rst
    docs/manual/webapi/2.0/resources/draft-file-attachment-list.rst
    docs/manual/webapi/2.0/resources/search.rst
    docs/manual/webapi/2.0/resources/file-attachment.rst
    docs/manual/webapi/2.0/resources/draft-diff.rst
    docs/manual/webapi/2.0/resources/draft-patched-file.rst
    docs/manual/webapi/2.0/resources/review-file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/api-token.rst
    docs/manual/webapi/2.0/resources/repository-branches.rst



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/resources/hosting_service_account.py
    docs/manual/_ext/webapidocs.py

Ignored Files:
    docs/manual/webapi/2.0/resources/change-list.rst
    docs/manual/webapi/2.0/resources/web-hook-list.rst
    docs/manual/webapi/2.0/resources/review-reply-file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/review-reply-file-attachment-comment.rst
    docs/manual/webapi/2.0/resources/draft-diff-list.rst
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/diff-file-attachment-list.rst
    docs/manual/webapi/2.0/resources/diff-context.rst
    docs/manual/webapi/2.0/resources/file-attachment-list.rst
    docs/manual/webapi/2.0/resources/change.rst
    docs/manual/webapi/2.0/resources/file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/validate-diff.rst
    docs/manual/webapi/2.0/resources/diff-file-attachment.rst
    docs/manual/webapi/2.0/resources/draft-file-diff-list.rst
    docs/manual/webapi/2.0/resources/original-file.rst
    docs/manual/webapi/2.0/resources/web-hook.rst
    docs/manual/webapi/2.0/resources/api-token-list.rst
    docs/manual/webapi/2.0/resources/draft-original-file.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/hosting-service-account.rst
    docs/manual/webapi/2.0/resources/validation.rst
    docs/manual/webapi/2.0/resources/remote-repository-list.rst
    docs/manual/webapi/2.0/resources/hosting-service-account-list.rst
    docs/manual/webapi/2.0/resources/default-reviewer-list.rst
    docs/manual/webapi/2.0/resources/remote-repository.rst
    docs/manual/webapi/2.0/resources/patched-file.rst
    docs/manual/webapi/2.0/resources/draft-file-attachment.rst
    docs/manual/webapi/2.0/resources/review-file-attachment-comment.rst
    docs/manual/webapi/2.0/resources/repository-commits.rst
    docs/manual/webapi/2.0/resources/default-reviewer.rst
    docs/manual/webapi/2.0/resources/draft-file-diff.rst
    docs/manual/webapi/2.0/resources/draft-file-attachment-list.rst
    docs/manual/webapi/2.0/resources/search.rst
    docs/manual/webapi/2.0/resources/file-attachment.rst
    docs/manual/webapi/2.0/resources/draft-diff.rst
    docs/manual/webapi/2.0/resources/draft-patched-file.rst
    docs/manual/webapi/2.0/resources/review-file-attachment-comment-list.rst
    docs/manual/webapi/2.0/resources/api-token.rst
    docs/manual/webapi/2.0/resources/repository-branches.rst

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-2.5.x (e3bcf3e)