General
- http://en.wikipedia.org/wiki/Representational_state_transfer
- http://stackoverflow.com/questions/778203/are-there-any-naming-convention-guidelines-for-rest-apis
- Endpoints should be nouns
Brown Dog (Initially Proposed)
DAP
| Resource | Description |
|---|---|
| POST convert/:output_format | Returns the given file in the output format specified. |
DTS
| Resource | Description |
|---|---|
| POST extract/:domain | Returns metadata stored in JSON extracted via extractors within the specified domain. |
Brown Dog (Current Thinking)
DAP
| Action | Resource | Description |
|---|---|---|
| Create | POST conversions/:output_format | Convert the given file to the output format specified. Returns an ID for the metadata results. |
| Get | GET conversions/:id | |
| List | GET conversions?since=...&until=... | |
| Remove | DELETE | |
| Update | POST/PUT conversions/:id |
DTS
| Resource | Description |
|---|---|
| POST extractions/:domain | Runs extractors on the given file using extractors within the specified domain. Returns an ID for the metadata results. |
| GET extractions/:id | Returns the extracted metdata in JSON for the given file ID. |
Medici
Polyglot
Versus
Cyberintegrator