Requirements

This is a comprehensive set of requirements to describe high level capabilities and features of the Core API service.

Intended as a traceable, authoritative itemization of requirements to trace functionalities, code, tests, and documentation back to.

Is NOT a low level implementation detailed document, rather a higher level set of generalized capabilities, requirements, and features. This means that things like specific data models, implementation details, and similar low level information is not here.

Requirement Groups:

• 1. Nonfunctional Features
  • 1.1. Scalability
  • 1.2. Resource Usage
  • 1.3. Metrics
  • 1.4. Deployment
• 2. Databases
  • 2.1. Support Many Databases
  • 2.2. Initial Database
  • 2.3. Database Creation
  • 2.4. Database Deletion
• 3. Entities, Auth, and Roles
  • 3.1. JWT Based Auth
  • 3.2. Roles
  • 3.3. Keep track of entities interacting with the system
  • 3.4. Allow entities to retrieve their own information
  • 3.5. Allow information to be retrieved on other entities
• 4. Interfaces
  • 4.1. REST
  • 4.2. Messaging
• 5. General Object Requirements
  • 5.1. Relations
  • 5.2. Data Changes
• 6. Files and Images
  • 6.1. Revisions
  • 6.2. Add
  • 6.3. Read Data
  • 6.4. Read Metadata
  • 6.5. Update File
  • 6.6. Update Metadata
  • 6.7. Delete
  • 6.8. Image Specific Requirements