Merge pull request #3 from Equal-IQ/contract-variables

 Add ContractVariable structure and ContractVariableType enum

Author: ParkerVR

Containers/Containerfile-python-codegen

@@ -12,6 +12,7 @@ COPY api.json /app/api.json
 RUN datamodel-codegen --input api.json --input-file-type openapi --output /app/models.py \
     --output-model-type pydantic_v2.BaseModel \
     --target-python-version 3.11 \
-    --field-constraints
+    --field-constraints \
+    --disable-timestamp
 
 CMD ["cat", "/app/models.py"]

README.md

@@ -10,6 +10,13 @@ https://smithy.io/2.0/index.html
 
 ## 🚀 Quickstart: Generate OpenAPI + Type Definitions
 
+Modify the model in ./smithy then run 
+
+```bash
+./build-openapi.sh && ./build-types.sh --all
+```
+
+
 ### 📦 Prerequisites
 
 Only **Docker** is required for containerized builds. No need to install Java, Gradle, Python, or Node.js locally.

model/equaliq.smithy

@@ -35,7 +35,9 @@ service EqualIQ {
 
 // When changing APIs, we sometimes want to expose unified types that aren't directly tied to any API.
 structure ExposedTypes { 
-  QASectionsList: QASectionsList
+  QASectionsList: QASectionsList // This type is not properly included in API response currently
+  ContractVariable: ContractVariable // New feature in development by Ty
+  ContractVariableType: ContractVariableType // New feature in development by Ty
 }
 
 // This API is used simply to expose types
@@ -102,6 +104,13 @@ enum SignContractResult {
     FAILURE
 }
 
+enum ContractVariableType {
+    EQ_TERM = "eq_term"
+    DISCOVERED_TERM = "discovered_term"
+    EXTERNAL_TERM = "external_term"
+    INTERNAL_CITATION = "internal_citation"
+}
+
 // Contract operations
 @http(method: "POST", uri: "/getContract")
 operation GetContract {
@@ -628,6 +637,41 @@ structure FixedTermValue {
     condition: String
 }
 
+// Contract variable structures
+
+structure ContractVariable {
+    @required
+    name: String
+
+    @required
+    type: ContractVariableType
+
+    @required
+    id: String
+
+    // the definition/explanation for this variable
+    value: String
+
+    // 1-10 difficulty level (external terms only)
+    level: Integer
+
+    confidence: Float
+
+    // character position
+    firstOccurrence: Integer
+
+    // surrounding text
+    context: String
+
+    // alternative forms
+    variations: StringList
+
+    // for internal citations
+    referencedSection: String
+
+    // where the term is defined (e.g., "Section 7(ii)(c)(I)") - for EQ_TERM and DISCOVERED_TERM only
+    definitionCitation: String
+}
 
 // Common structures
 document Document

python/api_model/types/models.py

@@ -1,6 +1,5 @@
 # generated by datamodel-codegen:
 #   filename:  api.json
-#   timestamp: 2025-07-03T19:26:05+00:00
 
 from __future__ import annotations
 
@@ -47,6 +46,13 @@ class ContractType(Enum):
     tbd = 'tbd'
 
 
+class ContractVariableType(Enum):
+    eq_term = 'eq_term'
+    discovered_term = 'discovered_term'
+    external_term = 'external_term'
+    internal_citation = 'internal_citation'
+
+
 class DeleteContractRequestContent(BaseModel):
     contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
 
@@ -259,13 +265,33 @@ class ContractSummaryItem(BaseModel):
     sharedEmails: Optional[List[str]] = None
 
 
+class ContractVariable(BaseModel):
+    name: str
+    type: ContractVariableType
+    id: str
+    value: Optional[str] = None
+    level: Optional[float] = None
+    confidence: Optional[float] = None
+    firstOccurrence: Optional[float] = None
+    context: Optional[str] = None
+    variations: Optional[List[str]] = None
+    referencedSection: Optional[str] = None
+    definitionCitation: Optional[str] = None
+
+
 class DeleteContractSignatureResponseContent(BaseModel):
     result: Optional[SignContractResult] = None
     message: Optional[str] = None
 
 
 class ExposeTypesResponseContent(BaseModel):
     QASectionsList: Optional[List[QASection]] = None
+    ContractVariable_1: Optional[ContractVariable] = Field(
+        None, alias='ContractVariable'
+    )
+    ContractVariableType_1: Optional[ContractVariableType] = Field(
+        None, alias='ContractVariableType'
+    )
 
 
 class GetContractResponseContent(BaseModel):

typescript/src/index.ts

@@ -14,6 +14,7 @@ type ExtractSchema<K extends SchemaNames> = components['schemas'][K];
 export type AuthenticationErrorResponseContent = ExtractSchema<'AuthenticationErrorResponseContent'>
 export type ContractSignature = ExtractSchema<'ContractSignature'>
 export type ContractSummaryItem = ExtractSchema<'ContractSummaryItem'>
+export type ContractVariable = ExtractSchema<'ContractVariable'>
 export type DeleteContractRequestContent = ExtractSchema<'DeleteContractRequestContent'>
 export type DeleteContractResponseContent = ExtractSchema<'DeleteContractResponseContent'>
 export type DeleteContractSignatureRequestContent = ExtractSchema<'DeleteContractSignatureRequestContent'>

typescript/src/models.ts

@@ -340,6 +340,22 @@ export interface components {
         };
         /** @enum {string} */
         ContractType: ContractType;
+        ContractVariable: {
+            name: string;
+            type: components["schemas"]["ContractVariableType"];
+            id: string;
+            value?: string;
+            level?: number;
+            /** Format: float */
+            confidence?: number;
+            firstOccurrence?: number;
+            context?: string;
+            variations?: string[];
+            referencedSection?: string;
+            definitionCitation?: string;
+        };
+        /** @enum {string} */
+        ContractVariableType: ContractVariableType;
         DeleteContractRequestContent: {
             contractId: string;
         };
@@ -355,6 +371,8 @@ export interface components {
         };
         ExposeTypesResponseContent: {
             QASectionsList?: components["schemas"]["QASection"][];
+            ContractVariable?: components["schemas"]["ContractVariable"];
+            ContractVariableType?: components["schemas"]["ContractVariableType"];
         };
         FixedTermValue: {
             unit: string;
@@ -1323,6 +1341,12 @@ export enum ContractType {
     services = "services",
     tbd = "tbd"
 }
+export enum ContractVariableType {
+    eq_term = "eq_term",
+    discovered_term = "discovered_term",
+    external_term = "external_term",
+    internal_citation = "internal_citation"
+}
 export enum SignContractResult {
     SUCCESS = "SUCCESS",
     FAILURE = "FAILURE"