Summary

Document extension API resources.

Review Request #4818 — Created Oct. 21, 2013 and submitted Oct. 21, 2013, 4:21 p.m.

Information

Owner

david

Repository

Review Board

Branch

master

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

Document extension API resources.

Extensions could add their own resources to the WebAPI, but this was never
documented. I've added a sample of this that looks a lot like Review Bot's
review resource, but simplified quite a bit to eliminate a lot of the actual
guts, leaving only a shell of a resource.

Testing Done

Generated HTML docs.

This is a review from Review Bot.
Tool: PEP8 Style Checker
Processed Files:
Ignored Files:
docs/manual/users/extending/extensions/overview.txt

This is a review from Review Bot.
Tool: Pyflakes
Processed Files:
Ignored Files:
docs/manual/users/extending/extensions/overview.txt

This looks fine, but assumes a lot of knowledge of how we do APIs. I think an example that does supports get, get_list, put and delete would be good. I don't mind if it's in a different change.

david Oct. 21, 2013, 3:52 p.m.

I think I'd prefer having comprehensive documentation of how we make APIs in the codebase docs, and we can cross-link it from here.

chipx86 Oct. 21, 2013, 4:13 p.m.
```
That's fine with me. Ship it.
```

Status: Closed (submitted)

Change Summary:

Pushed to master (a4866de).