Table of Contents |
---|
Anchor | ||||
---|---|---|---|---|
|
Name | Description |
API Name |
|
API Description |
|
Technical contact (Name and email) |
|
Operational contact (Name and email) |
|
Business contact (Name and email) |
|
Version |
|
API Consumer(s) E.g. Batch job, internal application, other departments, ITS, other UCs or any other university |
|
Anchor | ||||
---|---|---|---|---|
|
...
Name | Type | Required (yes/no) | Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Multimedia types |
|
...
Anchor | ||||
---|---|---|---|---|
|
Authentication |
|
|
| ||||||
Authorization |
|
|
| ||||||
Operation | Allowed (yes/no) | User Role (If any) | |||||||
READ |
|
| |||||||
WRITE |
|
| |||||||
UPDATE |
|
| |||||||
DELETE |
|
| |||||||
Need for fine grain authorization |
|
|
| ||||||
Data classification |
|
|
|
Non-functional Requirement
Describe the quality of services (QoS) that will be delivered by this API
Category | Requirement |
Throughput (Requests per second) - Average |
|
Throughput (Requests per second) – Max allowed |
|
Throughput – Max RPS allowed per user |
|
Max simultaneous users |
|
Uptime requirement |
|
API maintenance window |
|
...
The following revisions have been made to this document.
Version | Version Date | Revision Summary | Author |
1.0 | 01/01/2010 | First draft | Joe Smith |
...
This document has been reviewed and approved by the following signatories.
Approved By | Role/Area of Responsibility | Version | Date Approved | Approval Method |
Jane Doe | Sponsor, VC BA | 1.2 | 01/10/2010 | Approved Doc |
|
|
|
|