Difference between revisions of "TroveBlueprint"
(Template to publish a Trove Blueprint) |
(→Public API) |
||
| Line 19: | Line 19: | ||
* Does this change any API that an end-user has access to? | * Does this change any API that an end-user has access to? | ||
* Are there any exceptions in terms of consistency with other APIs? | * Are there any exceptions in terms of consistency with other APIs? | ||
| + | |||
| + | ==== CLI interface==== | ||
| + | * How will the command will look ? | ||
| + | * Does it extends the already existed command interfaces ? | ||
| + | |||
| + | ==== ReST Part ==== | ||
| + | * Which HTTP methods added ? | ||
| + | * Which routes were added/modified/extended? | ||
| + | * How does the Request body look like? | ||
| + | * How does the Response object look like? | ||
=== Internal API === | === Internal API === | ||
Revision as of 13:13, 7 March 2014
Contents
Description
Describe the purpose of the enhancement
Justification/Benefits
- What is the driving force behind this change?
- Does it allow for great flexibility? Stability? Security?
Impacts
Configuration
- Does this impact any configuration files? If so, which ones?
Database
- Does this impact any existing tables? If so, which ones?
- Are the changes forward and backward compatible?
- Be sure to include the expected migration process
Public API
- Does this change any API that an end-user has access to?
- Are there any exceptions in terms of consistency with other APIs?
CLI interface
- How will the command will look ?
- Does it extends the already existed command interfaces ?
ReST Part
- Which HTTP methods added ?
- Which routes were added/modified/extended?
- How does the Request body look like?
- How does the Response object look like?
Internal API
- Does this change any internal messages between API and Task Manager or Task Manager to Guest
Guest Agent
- Does this change behavior on the Guest Agent? If so, is it backwards compatible with API and Task Manager?
