aignostics · muhabalwan-aginx · Nov 27, 2025 · Nov 19, 2025 · Nov 19, 2025
diff --git a/docs/requirements/AGENT.md b/docs/requirements/AGENT.md
@@ -0,0 +1,28 @@
+# Requirements Documentation Instructions
+
+When creating or editing requirement documents:
+
+1. **Use the template** at `docs/requirements/TEMPLATE_SHR.md` for Stakeholder Requirement 
+
+2. **Use the template** at `docs/requirements/TEMPLATE_SWR.md` for Software Requirements 
+
+2. **Set Requirement Type** using this mapping:
+
+| Requirement Type              | Value                                   |
+| ----------------------------- | --------------------------------------- |
+| USE_CASE                      | Software requirement (regulatory)       |
+| TECHNICAL                     | Stakeholder requirement (system)        |
+| FUNCTIONAL                    | Software requirement (user)             |
+| INTERFACES                    | Stakeholder requirement (performance)   |
+| REGULATORY                    | Software requirement (system)           |
+| ENVIRONMENT                   | Stakeholder requirement (user)          |
+| SOFTWARE_IO                   | Software requirement (performance)      |
+| DOCUMENTATION                 | Stakeholder requirement (science)       |
+| FAULT_HANDLING                | Stakeholder requirement (business)      |
+| SOFTWARE_SYSTEM               | Stakeholder requirement (cybersecurity) |
+| USER_MAINTENANCE              | Software requirement (other)            |
+| DATA_AND_DATABASES            | Software requirement (cybersecurity)    |
+| EXTERNAL_INTERFACES           | Stakeholder requirement (regulatory)    |
+| ACCOMPANYING_DOCUMENTS        | Software requirement (business)         |
+| USER_INTERFACE_SPECIFICATION  | Software requirement (user interface)   |
+| ESSENTIAL_FUNCTION_PROTECTION | Software requirement (science)          |
diff --git a/docs/requirements/SHR-APP-DISCOVERY.md b/docs/requirements/SHR-APP-DISCOVERY.md
@@ -0,0 +1,13 @@
+---
+itemId: SHR-APP-DISCOVERY
+itemTitle: Application Discovery
+itemType: Requirement
+# Stakeholder requirement (user)
+Requirement type: FUNCTIONAL
+---
+
+<!-- Original reference: SHR-TSSDK-2 -->
+
+## Description
+
+Users shall be able to discover available AI applications and their versions.
diff --git a/docs/requirements/SHR-APP-EXEC.md b/docs/requirements/SHR-APP-EXEC.md
@@ -0,0 +1,13 @@
+---
+itemId: SHR-APP-EXEC
+itemTitle: Application Execution Access
+itemType: Requirement
+# Stakeholder requirement (user)
+Requirement type: FUNCTIONAL
+---
+
+<!-- Original reference: SHR-TSSDK-3 -->
+
+## Description
+
+Users shall be able to execute AI applications on slide data to generate analytical insights.
diff --git a/docs/requirements/SHR-APP-RESULTS.md b/docs/requirements/SHR-APP-RESULTS.md
@@ -0,0 +1,13 @@
+---
+itemId: SHR-APP-RESULTS
+itemTitle: Application Results Access
+itemType: Requirement
+# Stakeholder requirement (user)
+Requirement type: FUNCTIONAL
+---
+
+<!-- Original reference: SHR-TSSDK-5 -->
+
+## Description
+
+Users shall be able to access and retrieve results generated from AI application runs.
diff --git a/docs/requirements/SHR-APP-RUN-MGMT.md b/docs/requirements/SHR-APP-RUN-MGMT.md
@@ -0,0 +1,13 @@
+---
+itemId: SHR-APP-RUN-MGMT
+itemTitle: Application Run Management
+itemType: Requirement
+# Stakeholder requirement (user)
+Requirement type: FUNCTIONAL
+---
+
+<!-- Original reference: SHR-TSSDK-4 -->
+
+## Description
+
+Users shall be able to monitor status and manage the lifecycle of their AI application runs.
diff --git a/docs/requirements/SHR-AUTH.md b/docs/requirements/SHR-AUTH.md
@@ -0,0 +1,13 @@
+---
+itemId: SHR-AUTH
+itemTitle: Authenticated Platform Access
+itemType: Requirement
+# Stakeholder requirement (user)
+Requirement type: SECURITY
+---
+
+<!-- Original reference: SHR-TSSDK-1 -->
+
+## Description
+
+Access to the Aignostics Platform shall require valid user authentication credentials.
diff --git a/docs/requirements/SHR-ERROR-COMM.md b/docs/requirements/SHR-ERROR-COMM.md
@@ -0,0 +1,13 @@
+---
+itemId: SHR-ERROR-COMM
+itemTitle: Error Communication
+itemType: Requirement
+# Stakeholder requirement (user)
+Requirement type: FUNCTIONAL
+---
+
+<!-- Original reference: SHR-TSSDK-6 -->
+
+## Description
+
+Users shall receive clear information when operations fail.
diff --git a/docs/requirements/SWR-APP-DISCOVERY-DETAILS.md b/docs/requirements/SWR-APP-DISCOVERY-DETAILS.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-DISCOVERY-DETAILS
+itemTitle: Application Details
+itemHasParent: SHR-APP-DISCOVERY
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-2.2 -->
+
+System shall provide application identification, description, and regulatory compliance information for each retrieved application.
diff --git a/docs/requirements/SWR-APP-DISCOVERY-LIST.md b/docs/requirements/SWR-APP-DISCOVERY-LIST.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-DISCOVERY-LIST
+itemTitle: Application List Retrieval
+itemHasParent: SHR-APP-DISCOVERY
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-2.1 -->
+
+System shall retrieve all available AI applications accessible to the authenticated user.
diff --git a/docs/requirements/SWR-APP-DISCOVERY-VERSION-DETAILS.md b/docs/requirements/SWR-APP-DISCOVERY-VERSION-DETAILS.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-DISCOVERY-VERSION-DETAILS
+itemTitle: Version Details
+itemHasParent: SHR-APP-DISCOVERY
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-2.4 -->
+
+System shall provide version identification, change history, input requirements, and output specifications for each retrieved version.
diff --git a/docs/requirements/SWR-APP-DISCOVERY-VERSION-LIST.md b/docs/requirements/SWR-APP-DISCOVERY-VERSION-LIST.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-DISCOVERY-VERSION-LIST
+itemTitle: Version List Retrieval
+itemHasParent: SHR-APP-DISCOVERY
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-2.3 -->
+
+System shall retrieve all versions for a specified application.
diff --git a/docs/requirements/SWR-APP-EXEC-INPUT-ARTIFACT.md b/docs/requirements/SWR-APP-EXEC-INPUT-ARTIFACT.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-EXEC-INPUT-ARTIFACT
+itemTitle: Input Artifact Specification
+itemHasParent: SHR-APP-EXEC
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-3.2 -->
+
+System shall accept input artifacts containing artifact name, download URL, and metadata for each item in the run request.
diff --git a/docs/requirements/SWR-APP-EXEC-REQUEST-VALIDATION.md b/docs/requirements/SWR-APP-EXEC-REQUEST-VALIDATION.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-EXEC-REQUEST-VALIDATION
+itemTitle: Request Validation
+itemHasParent: SHR-APP-EXEC
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-3.3 -->
+
+System shall validate run request format before submission to the platform.
diff --git a/docs/requirements/SWR-APP-EXEC-RUN-CREATION.md b/docs/requirements/SWR-APP-EXEC-RUN-CREATION.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-EXEC-RUN-CREATION
+itemTitle: Application Run Creation
+itemHasParent: SHR-APP-EXEC
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-3.1 -->
+
+System shall create application runs with specified application version, input items, and item- and run metadata and return a unique run identifier upon successful creation.
diff --git a/docs/requirements/SWR-APP-RESULTS-ARTIFACT-STATUS.md b/docs/requirements/SWR-APP-RESULTS-ARTIFACT-STATUS.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-RESULTS-ARTIFACT-STATUS
+itemTitle: Artifact Status Information
+itemHasParent: SHR-APP-RESULTS
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-5.3 -->
+
+System shall provide execution state, download availability, termination status, and error details for each output artifact.
diff --git a/docs/requirements/SWR-APP-RESULTS-ITEM-STATUS.md b/docs/requirements/SWR-APP-RESULTS-ITEM-STATUS.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-RESULTS-ITEM-STATUS
+itemTitle: Item Status Information
+itemHasParent: SHR-APP-RESULTS
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-5.2 -->
+
+System shall provide execution state, output availability, termination status, and error details for each item.
diff --git a/docs/requirements/SWR-APP-RESULTS-RETRIEVE-ITEMS.md b/docs/requirements/SWR-APP-RESULTS-RETRIEVE-ITEMS.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-RESULTS-RETRIEVE-ITEMS
+itemTitle: Retrieve Run Items
+itemHasParent: SHR-APP-RESULTS
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-5.1 -->
+
+System shall retrieve items and their associated output artifacts for a specified application run by run ID.
diff --git a/docs/requirements/SWR-APP-RUN-MGMT-CANCEL.md b/docs/requirements/SWR-APP-RUN-MGMT-CANCEL.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-RUN-MGMT-CANCEL
+itemTitle: Cancel Application Run
+itemHasParent: SHR-APP-RUN-MGMT
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-4.3 -->
+
+System shall enable users to cancel a running or queued application run by run ID.
diff --git a/docs/requirements/SWR-APP-RUN-MGMT-DEADLINE.md b/docs/requirements/SWR-APP-RUN-MGMT-DEADLINE.md
@@ -0,0 +1,14 @@
+---
+itemId: SWR-APP-RUN-MGMT-DEADLINE
+itemTitle: Run Deadline Specification
+itemHasParent: SHR-APP-RUN-MGMT
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-4.5 -->
+<!-- NOT YET IMPLEMENTED -->
+
+System shall accept optional deadline timestamp when creating application runs to specify when the Platform API should automatically cancel the run if not completed.
diff --git a/docs/requirements/SWR-APP-RUN-MGMT-DETAILS.md b/docs/requirements/SWR-APP-RUN-MGMT-DETAILS.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-RUN-MGMT-DETAILS
+itemTitle: Retrieve Run Details
+itemHasParent: SHR-APP-RUN-MGMT
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-4.2 -->
+
+System shall retrieve detailed information for a specific application run by run ID.
diff --git a/docs/requirements/SWR-APP-RUN-MGMT-DUE-DATE.md b/docs/requirements/SWR-APP-RUN-MGMT-DUE-DATE.md
@@ -0,0 +1,14 @@
+---
+itemId: SWR-APP-RUN-MGMT-DUE-DATE
+itemTitle: Run Due Date Specification
+itemHasParent: SHR-APP-RUN-MGMT
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-4.4 -->
+<!-- NOT YET IMPLEMENTED -->
+
+System shall accept optional due date timestamp when creating application runs to specify the expected completion time.
diff --git a/docs/requirements/SWR-APP-RUN-MGMT-LIST.md b/docs/requirements/SWR-APP-RUN-MGMT-LIST.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-APP-RUN-MGMT-LIST
+itemTitle: List Application Runs
+itemHasParent: SHR-APP-RUN-MGMT
+itemType: Requirement
+# Software requirement (user)
+Requirement type: FUNCTIONAL
+Layer: System (backend logic)
+---
+
+<!-- Original reference: SWR-TSSDK-4.1 -->
+
+System shall retrieve a list of application runs with optional filtering by application ID and application version.
diff --git a/docs/requirements/SWR-AUTH-AUTO-REFRESH.md b/docs/requirements/SWR-AUTH-AUTO-REFRESH.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-AUTH-AUTO-REFRESH
+itemTitle: Automatic Token Refresh
+itemHasParent: SHR-AUTH
+itemType: Requirement
+# Software requirement (system)
+Requirement type: SECURITY
+Layer: CLI
+---
+
+<!-- Original reference: SWR-TSSDK-1.6 -->
+
+CLI shall automatically refresh access tokens and retry failed API requests when authentication fails and valid refresh tokens are available.
diff --git a/docs/requirements/SWR-AUTH-CODE-FLOW.md b/docs/requirements/SWR-AUTH-CODE-FLOW.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-AUTH-CODE-FLOW
+itemTitle: Secure Authorisation Code Authentication
+itemHasParent: SHR-AUTH
+itemType: Requirement
+# Software requirement (system)
+Requirement type: SECURITY
+Layer: CLI
+---
+
+<!-- Original reference: SWR-TSSDK-1.3 -->
+
+CLI shall support secure authorization code-based authentication flow with cryptographic protection against authorization code interception attacks.
diff --git a/docs/requirements/SWR-AUTH-CUSTOM-PROVIDER.md b/docs/requirements/SWR-AUTH-CUSTOM-PROVIDER.md
@@ -0,0 +1,12 @@
+---
+itemId: SWR-AUTH-CUSTOM-PROVIDER
+itemTitle: Custom Token Provider
+itemHasParent: SHR-AUTH
+itemType: Requirement
+# Software requirement (system)
+Requirement type: SECURITY
+---
+
+<!-- Original reference: SWR-TSSDK-1.4 -->
+
+SDK shall accept user-provided token functions for obtaining access tokens.
diff --git a/docs/requirements/SWR-AUTH-SECURE-STORAGE.md b/docs/requirements/SWR-AUTH-SECURE-STORAGE.md
@@ -0,0 +1,13 @@
+---
+itemId: SWR-AUTH-SECURE-STORAGE
+itemTitle: Secure Token Storage
+itemHasParent: SHR-AUTH
+itemType: Requirement
+# Software requirement (system)
+Requirement type: SECURITY
+Layer: CLI
+---
+
+<!-- Original reference: SWR-TSSDK-1.5 -->
+
+CLI shall store authentication tokens with protection against unauthorized access.
diff --git a/docs/requirements/SWR-AUTH-TOKEN-BASED.md b/docs/requirements/SWR-AUTH-TOKEN-BASED.md
@@ -0,0 +1,12 @@
+---
+itemId: SWR-AUTH-TOKEN-BASED
+itemTitle: Token-Based Authentication
+itemHasParent: SHR-AUTH
+itemType: Requirement
+# Software requirement (system)
+Requirement type: SECURITY
+---
+
+<!-- Original reference: SWR-TSSDK-1.1 -->
+
+System shall authenticate API requests using access tokens.