Render pydantic v2 types

Author: ParkerVR

Containers/Containerfile-python-codegen

@@ -0,0 +1,17 @@
+FROM python:3.9-slim
+
+WORKDIR /app
+
+# Install the latest version of datamodel-code-generator
+RUN pip install --no-cache-dir 'datamodel-code-generator>=0.25.0'
+
+# Copy the OpenAPI file
+COPY api.json /app/api.json
+
+# Generate the models with Pydantic v2 compatibility
+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
+
+CMD ["cat", "/app/models.py"]

Containers/Containerfile-typescript-codegen

@@ -0,0 +1,15 @@
+FROM node:18-slim
+
+WORKDIR /app
+
+# Install dependencies
+RUN npm install openapi-typescript
+
+# Copy files
+COPY api.json /app/api.json
+COPY generate.js /app/generate.js
+
+# Generate the models
+RUN node generate.js
+
+CMD ["cat", "/app/models.ts"]

Containers/generate.js

@@ -0,0 +1,36 @@
+const fs = require('fs');
+const { exec } = require('child_process');
+
+// Generate the base TypeScript file from OpenAPI
+exec('npx openapi-typescript /app/api.json -o /app/models.ts', (error, stdout, stderr) => {
+  if (error) {
+    console.error('Error generating TypeScript types:', error);
+    console.error(stderr);
+    process.exit(1);
+  }
+  console.log(stdout);
+  console.log('TypeScript base models generated successfully');
+  
+  // Now create an index.ts file that exports all the components.schemas
+  const indexContent = `// Auto-generated index file
+// Export all schemas from the OpenAPI specification
+export * from './models';
+export { components } from './models';
+
+// Re-export schemas as top-level types for easier importing
+import { components } from './models';
+export type Schemas = components['schemas'];
+
+// Make each schema available as a top-level export
+type SchemaNames = keyof components['schemas'];
+type ExtractSchema<K extends SchemaNames> = components['schemas'][K];
+
+${Object.keys(require('/app/api.json').components.schemas)
+  .map(schemaName => `export type ${schemaName} = ExtractSchema<'${schemaName}'>`)
+  .join('\n')
+}
+`;
+
+  fs.writeFileSync('/app/index.ts', indexContent);
+  console.log('TypeScript index with type exports generated successfully');
+});

README.md

@@ -51,7 +51,7 @@ For a completely containerized build without requiring local installations:
 chmod +x build-docker.sh build-types.sh
 
 # Run the Smithy build in Docker
-./build-docker.sh
+./build-openapi.sh
 ```
 
 This will:

build-docker.sh

@@ -69,32 +69,14 @@ fi
 if [[ "$PYTHON" == "true" ]]; then
   echo "Generating Python models..."
 
-  # Create a temporary directory for our Dockerfile and context
+  # Create a temporary directory for our container context
   TEMP_DIR=$(mktemp -d)
 
   # Copy the OpenAPI file to the temp directory
   cp "$OPENAPI_FILE" "$TEMP_DIR/api.json"
 
-  # Create a Dockerfile for Python
-  cat > "$TEMP_DIR/Dockerfile" << EOF
-FROM python:3.9-slim
-
-WORKDIR /app
-
-# Install dependencies
-RUN pip install --no-cache-dir datamodel-code-generator
-
-# Copy the OpenAPI file
-COPY api.json /app/api.json
-
-# Generate the models
-RUN datamodel-codegen --input api.json --input-file-type openapi --output /app/models.py
-
-CMD ["cat", "/app/models.py"]
-EOF
-  
-  # Build and run the container, capturing the output directly
-  (cd "$TEMP_DIR" && docker build -t equaliq-python-codegen .)
+  # Build and run the container using the external Containerfile
+  docker build -t equaliq-python-codegen -f Containers/Containerfile-python-codegen "$TEMP_DIR"
 
   # Ensure the python package directory exists
   mkdir -p "$PYTHON_PACKAGE_DIR"
@@ -122,73 +104,17 @@ fi
 if [[ "$TYPESCRIPT" == "true" ]]; then
   echo "Generating TypeScript types..."
 
-  # Create a temporary directory for our Dockerfile and context
+  # Create a temporary directory for our container context
   TEMP_DIR=$(mktemp -d)
 
   # Copy the OpenAPI file to the temp directory
   cp "$OPENAPI_FILE" "$TEMP_DIR/api.json"
 
-  # Create a typescript generator script
-  cat > "$TEMP_DIR/generate.js" << EOF
-const fs = require('fs');
-const { exec } = require('child_process');
-
-// Generate the base TypeScript file from OpenAPI
-exec('npx openapi-typescript /app/api.json -o /app/models.ts', (error, stdout, stderr) => {
-  if (error) {
-    console.error('Error generating TypeScript types:', error);
-    console.error(stderr);
-    process.exit(1);
-  }
-  console.log(stdout);
-  console.log('TypeScript base models generated successfully');
-  
-  // Now create an index.ts file that exports all the components.schemas
-  const indexContent = \`// Auto-generated index file
-// Export all schemas from the OpenAPI specification
-export * from './models';
-export { components } from './models';
-
-// Re-export schemas as top-level types for easier importing
-import { components } from './models';
-export type Schemas = components['schemas'];
-
-// Make each schema available as a top-level export
-type SchemaNames = keyof components['schemas'];
-type ExtractSchema<K extends SchemaNames> = components['schemas'][K];
-
-\${Object.keys(require('/app/api.json').components.schemas)
-  .map(schemaName => \`export type \${schemaName} = ExtractSchema<'\${schemaName}'>\`)
-  .join('\\n')
-}
-\`;
-
-  fs.writeFileSync('/app/index.ts', indexContent);
-  console.log('TypeScript index with type exports generated successfully');
-});
-EOF
-  
-  # Create a Dockerfile for TypeScript
-  cat > "$TEMP_DIR/Dockerfile" << EOF
-FROM node:18-slim
-
-WORKDIR /app
-
-# Install dependencies
-RUN npm install openapi-typescript
-
-# Copy files
-COPY api.json /app/api.json
-COPY generate.js /app/generate.js
-
-# Generate the models
-RUN node generate.js
-
-CMD ["cat", "/app/models.ts"]
-EOF
+  # Copy the generate.js file to the temp directory
+  cp "Containers/generate.js" "$TEMP_DIR/generate.js"
 
-  # Build and run the container, capturing the output directly
-  (cd "$TEMP_DIR" && docker build -t equaliq-ts-codegen .)
+  # Build and run the container using the external Containerfile
+  docker build -t equaliq-ts-codegen -f Containers/Containerfile-typescript-codegen "$TEMP_DIR"
 
   # Ensure the typescript package directory exists
   mkdir -p "$TYPESCRIPT_PACKAGE_DIR"

build-types.sh

@@ -1,13 +1,13 @@
 # generated by datamodel-codegen:
 #   filename:  api.json
-#   timestamp: 2025-04-06T09:43:17+00:00
+#   timestamp: 2025-04-07T07:17:17+00:00
 
 from __future__ import annotations
 
 from enum import Enum
 from typing import Any, List, Optional
 
-from pydantic import BaseModel, constr
+from pydantic import BaseModel, Field, RootModel
 
 
 class AccountType(Enum):
@@ -28,6 +28,10 @@ class ContractStatus(Enum):
     awaiting_upload = 'awaiting_upload'
 
 
+class SharedWithItem(RootModel[str]):
+    root: str = Field(..., pattern='^[A-Za-z0-9-]+$')
+
+
 class ContractType(Enum):
     recording = 'recording'
     publishing = 'publishing'
@@ -37,27 +41,27 @@ class ContractType(Enum):
 
 
 class DeleteContractRequestContent(BaseModel):
-    contractId: constr(regex=r'^[A-Za-z0-9-]+$')
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
 
 
 class DeleteContractResponseContent(BaseModel):
     success: bool
 
 
 class GetContractReadURLRequestContent(BaseModel):
-    contractId: constr(regex=r'^[A-Za-z0-9-]+$')
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
 
 
 class GetContractReadURLResponseContent(BaseModel):
     url: str
 
 
 class GetContractRequestContent(BaseModel):
-    contractId: constr(regex=r'^[A-Za-z0-9-]+$')
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
 
 
 class GetProfileRequestContent(BaseModel):
-    userId: Optional[constr(regex=r'^[A-Za-z0-9-]+$')] = None
+    userId: Optional[str] = Field(None, pattern='^[A-Za-z0-9-]+$')
 
 
 class GetUploadURLRequestContent(BaseModel):
@@ -91,19 +95,19 @@ class ResourceNotFoundErrorResponseContent(BaseModel):
 
 
 class ShareContractRequestContent(BaseModel):
-    contractId: constr(regex=r'^[A-Za-z0-9-]+$')
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     emailsToAdd: Optional[List[str]] = None
     emailsToRemove: Optional[List[str]] = None
 
 
 class SharedUserDetails(BaseModel):
-    userId: constr(regex=r'^[A-Za-z0-9-]+$')
+    userId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     email: str
     sharedTime: float
 
 
 class UpdateContractRequestContent(BaseModel):
-    contractId: constr(regex=r'^[A-Za-z0-9-]+$')
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     name: str
 
 
@@ -123,12 +127,12 @@ class UpdateProfileRequestContent(BaseModel):
 class UpdateProfileResponseContent(BaseModel):
     success: bool
     message: str
-    userId: constr(regex=r'^[A-Za-z0-9-]+$')
+    userId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     updatedFields: Optional[List[str]] = None
 
 
 class UserProfile(BaseModel):
-    userId: Optional[constr(regex=r'^[A-Za-z0-9-]+$')] = None
+    userId: Optional[str] = Field(None, pattern='^[A-Za-z0-9-]+$')
     firstName: Optional[str] = None
     lastName: Optional[str] = None
     displayName: Optional[str] = None
@@ -142,18 +146,18 @@ class ValidationErrorResponseContent(BaseModel):
 
 
 class ContractSummaryItem(BaseModel):
-    contractId: constr(regex=r'^[A-Za-z0-9-]+$')
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     name: str
     uploadedOn: float
     type: ContractType
     status: ContractStatus
     isOwner: bool
-    ownerId: constr(regex=r'^[A-Za-z0-9-]+$')
-    sharedWith: Optional[List[constr(regex=r'^[A-Za-z0-9-]+$')]] = None
+    ownerId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
+    sharedWith: Optional[List[SharedWithItem]] = None
 
 
 class GetProfileResponseContent(BaseModel):
-    userId: constr(regex=r'^[A-Za-z0-9-]+$')
+    userId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     profile: UserProfile
 
 
@@ -177,19 +181,19 @@ class QASections(BaseModel):
 
 class ShareContractResponseContent(BaseModel):
     success: bool
-    contractId: constr(regex=r'^[A-Za-z0-9-]+$')
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     sharedWith: List[SharedUserDetails]
     added: Optional[List[str]] = None
     removed: Optional[List[str]] = None
     invalidRemoves: Optional[List[str]] = None
 
 
 class GetContractResponseContent(BaseModel):
-    contractId: constr(regex=r'^[A-Za-z0-9-]+$')
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     name: str
     type: ContractType
     terms: Any
     iq_qa: QASections
     isOwner: bool
-    ownerId: constr(regex=r'^[A-Za-z0-9-]+$')
-    sharedWith: List[constr(regex=r'^[A-Za-z0-9-]+$')]
+    ownerId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
+    sharedWith: List[SharedWithItem]