Skip to content

Commit 2c22065

Browse files
muhabalwan-aginxmuhabalwan-aginx
committed
chore(docs): add requirements mds for existing and to be implemented functionalities
1 parent f55a34e commit 2c22065

36 files changed

+1031
-0
lines changed

‎docs/requirements/AGENT.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Requirements Documentation Instructions
2+
3+
When creating or editing requirement documents:
4+
5+
1. **Use the template** at `docs/requirements/SWR-TEMPLATE.md`
6+
7+
2. **Set Requirement Type** using this mapping:
8+
9+
| Requirement Type | Value |
10+
| ----------------------------- | --------------------------------------- |
11+
| USE_CASE | Software requirement (regulatory) |
12+
| TECHNICAL | Stakeholder requirement (system) |
13+
| FUNCTIONAL | Software requirement (user) |
14+
| INTERFACES | Stakeholder requirement (performance) |
15+
| REGULATORY | Software requirement (system) |
16+
| ENVIRONMENT | Stakeholder requirement (user) |
17+
| SOFTWARE_IO | Software requirement (performance) |
18+
| DOCUMENTATION | Stakeholder requirement (science) |
19+
| FAULT_HANDLING | Stakeholder requirement (business) |
20+
| SOFTWARE_SYSTEM | Stakeholder requirement (cybersecurity) |
21+
| USER_MAINTENANCE | Software requirement (other) |
22+
| DATA_AND_DATABASES | Software requirement (cybersecurity) |
23+
| EXTERNAL_INTERFACES | Stakeholder requirement (regulatory) |
24+
| ACCOMPANYING_DOCUMENTS | Software requirement (business) |
25+
| USER_INTERFACE_SPECIFICATION | Software requirement (user interface) |
26+
| ESSENTIAL_FUNCTION_PROTECTION | Software requirement (science) |

‎docs/requirements/AllRequirements.md‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
Typescript SDK - Requirements
2+
Author Omid Kokabi
3+
Date Oct 14, 2025
4+
5+
Color coding
6+
Black = Requirements that are already implemented
7+
Red = Requirements that are not yet implemented
8+
9+
Requirements
10+
SHR: TSSDK-1 - Authenticated Platform Access
11+
Requirement Type: Stakeholder requirement (security)
12+
Description: Access to the Aignostics Platform shall require valid user authentication credentials.
13+
14+
SWR-TSSDK-1.1: Token-Based Authentication
15+
Requirement Type: Software requirement (security)
16+
Description: System shall authenticate API requests using access tokens.
17+
18+
SWR-TSSDK-1.2: Authentication Validation
19+
Requirement Type: Software requirement (security)
20+
Description: CLI shall reject API requests that do not include a valid access token.
21+
22+
SWR-TSSDK-1.3: Secure authorisation code authentication
23+
Requirement Type: Software requirement (security)
24+
Description: CLI shall support secure authorization code-based authentication flow with cryptographic protection against authorization code interception attacks.
25+
26+
SWR-TSSDK-1.4: Custom Token Provider
27+
Requirement Type: Software requirement (security)
28+
Description: SDK shall accept user-provided token functions for obtaining access tokens.
29+
30+
SWR-TSSDK-1.5: Secure Token Storage
31+
Requirement Type: Software requirement (security)
32+
Description: CLI shall store authentication tokens with protection against unauthorized access.
33+
34+
SWR-TSSDK-1.6: Automatic Token Refresh
35+
Requirement Type: Software requirement (security)
36+
Description: CLI shall automatically refresh access tokens and retry failed API requests when authentication fails and valid refresh tokens are available
37+
38+
SWR-TSSDK-1.7: Token Removal
39+
Requirement Type: Software requirement (security)
40+
Description: CLI shall enable users to remove stored authentication tokens.
41+
42+
43+
SHR: TSSDK-2 - Application Discovery
44+
Requirement Type: Stakeholder requirement (user)
45+
Description: Users shall be able to discover available AI applications and their versions.
46+
47+
SWR-TSSDK-2.1: Application List Retrieval
48+
Requirement Type: Software requirement (user)
49+
Description: System shall retrieve all available AI applications accessible to the authenticated user.
50+
51+
SWR-TSSDK-2.2: Application Details
52+
Requirement Type: Software requirement (user)
53+
Description: System shall provide application identification, description, and regulatory compliance information for each retrieved application.
54+
55+
SWR-TSSDK-2.3: Version List Retrieval
56+
Requirement Type: Software requirement (user)
57+
Description: System shall retrieve all versions for a specified application.
58+
59+
SWR-TSSDK-2.4: Version Details
60+
Requirement Type: Software requirement (user)
61+
Description: System shall provide version identification, change history, input requirements, and output specifications for each retrieved version.
62+
63+
64+
SHR: TSSDK-3 - Application Execution Access
65+
Requirement Type: Stakeholder requirement (user)
66+
Description: Users shall be able to execute AI applications on slide data to generate analytical insights.
67+
68+
SWR-TSSDK-3.1: Application Run Creation
69+
Requirement Type: Software requirement (user)
70+
Description: 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.
71+
72+
SWR-TSSDK-3.2: Input Artifact Specification
73+
Requirement Type: Software requirement (user)
74+
Description: System shall accept input artifacts containing artifact name, download URL, and metadata for each item in the run request.
75+
76+
SWR-TSSDK-3.3: Request Validation
77+
Requirement Type: Software requirement (user)
78+
Description: System shall validate run request format before submission to the platform.
79+
80+
SHR: TSSDK-4 - Application Run Management
81+
Requirement Type: Stakeholder requirement (user)
82+
Description: Users shall be able to monitor status and manage the lifecycle of their AI application runs.
83+
84+
SWR-TSSDK-4.1: List Application Runs
85+
Requirement Type: Software requirement (user)
86+
Description: System shall retrieve a list of application runs with optional filtering by application ID and application version.
87+
88+
SWR-TSSDK-4.2: Retrieve Run Details
89+
Requirement Type: Software requirement (user)
90+
Description: System shall retrieve detailed information for a specific application run by run ID.
91+
92+
SWR-TSSDK-4.3: Cancel Application Run
93+
Requirement Type: Software requirement (user)
94+
Description: System shall enable users to cancel a running or queued application run by run ID.
95+
96+
SWR-TSSDK-4.4: Run Due Date Specification
97+
Requirement Type: Software requirement (user)
98+
Description: System shall accept optional due date timestamp when creating application runs to specify the expected completion time.
99+
100+
SWR-TSSDK-4.5:Run Deadline Specification
101+
Requirement Type: Software requirement (user)
102+
Description: System shall accept optional deadline timestamp when creating application runs to specify when the
103+
Platform API should automatically cancel the run if not completed.
104+
SHR: TSSDK-5 - Application Results Access
105+
Requirement Type: Stakeholder requirement (user)
106+
Description: Users shall be able to access and retrieve results generated from AI application runs.
107+
108+
SWR-TSSDK-5.1: Retrieve run items
109+
Requirement Type: Software requirement (user)
110+
Description: System shall retrieve items and their associated output artifacts for a specified application run by run ID.
111+
112+
SWR-TSSDK-5.2: Item status information
113+
Requirement Type: Software requirement (user)
114+
Description: System shall provide execution state, output availability, termination status, and error details for each item.
115+
116+
SWR-TSSDK-5.3: Artifact status information
117+
Requirement Type: Software requirement (user)
118+
Description: System shall provide execution state, download availability, termination status, and error details for each output artifact.
119+
120+
121+
SHR: TSSDK-6 - Error Communication
122+
Requirement Type: Stakeholder requirement (user)
123+
Description: Users shall receive clear information when operations fail.
124+
125+
SWR-TSSDK-6.1: Error Classification
126+
Requirement Type: Software requirement (user)
127+
Description: System shall assign a unique error code to each error to enable programmatic error handling and differentiation between error types.
128+
129+
SWR-TSSDK-6.2: Error Messages
130+
Requirement Type: Software requirement (user)
131+
Description: System shall provide error messages that describe the failure cause and corrective action where applicable.
132+
133+
SWR-TSSDK-6.3: Error Diagnostic Context
134+
Requirement Type: Software requirement (user)
135+
Description: System shall include diagnostic context in errors including protocol-specific status information for API failures and original error details for debugging.
136+
137+
SWR-TSSDK-6.4: CLI Error Output
138+
Requirement Type: Software requirement (user)
139+
Description: CLI shall write error messages to standard error stream and provide machine-readable operation status through standard exit mechanisms.
140+
141+
142+
143+
144+
145+
146+
147+
148+
149+

‎docs/requirements/SHR-TSSDK-1.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-TSSDK-1
3+
itemTitle: Authenticated Platform Access
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: SECURITY
7+
---
8+
9+
<!-- Original reference: SHR: TSSDK-1 -->
10+
11+
## Description
12+
13+
Access to the Aignostics Platform shall require valid user authentication credentials.

‎docs/requirements/SHR-TSSDK-2.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-TSSDK-2
3+
itemTitle: Application Discovery
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR: TSSDK-2 -->
10+
11+
## Description
12+
13+
Users shall be able to discover available AI applications and their versions.

‎docs/requirements/SHR-TSSDK-3.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-TSSDK-3
3+
itemTitle: Application Execution Access
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR: TSSDK-3 -->
10+
11+
## Description
12+
13+
Users shall be able to execute AI applications on slide data to generate analytical insights.

‎docs/requirements/SHR-TSSDK-4.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-TSSDK-4
3+
itemTitle: Application Run Management
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR: TSSDK-4 -->
10+
11+
## Description
12+
13+
Users shall be able to monitor status and manage the lifecycle of their AI application runs.

‎docs/requirements/SHR-TSSDK-5.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-TSSDK-5
3+
itemTitle: Application Results Access
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR: TSSDK-5 -->
10+
11+
## Description
12+
13+
Users shall be able to access and retrieve results generated from AI application runs.

‎docs/requirements/SHR-TSSDK-6.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-TSSDK-6
3+
itemTitle: Error Communication
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR: TSSDK-6 -->
10+
11+
## Description
12+
13+
Users shall receive clear information when operations fail.

‎docs/requirements/SWR-TSSDK-1-1.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
itemId: SWR-TSSDK-1-1
3+
itemTitle: Token-Based Authentication
4+
itemHasParent: SHR-TSSDK-1
5+
itemType: Requirement
6+
# Software requirement (system)
7+
Requirement type: SECURITY
8+
---
9+
10+
<!-- Original reference: SWR-TSSDK-1.1 -->
11+
12+
System shall authenticate API requests using access tokens.

‎docs/requirements/SWR-TSSDK-1-2.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SWR-TSSDK-1-2
3+
itemTitle: Authentication Validation
4+
itemHasParent: SHR-TSSDK-1
5+
itemType: Requirement
6+
# Software requirement (system)
7+
Requirement type: SECURITY
8+
Layer: CLI
9+
---
10+
11+
<!-- Original reference: SWR-TSSDK-1.2 -->
12+
13+
CLI shall reject API requests that do not include a valid access token.

0 commit comments

Comments
 (0)