add in user, edit output.sh, revert schema_extra

microsoft · Nov 13, 2024 · e36ca15 · e36ca15
1 parent 19960ae
commit e36ca15
Show file tree

Hide file tree

Showing 18 changed files with 49 additions and 40 deletions.
diff --git a/api_app/models/domain/operation.py b/api_app/models/domain/operation.py
@@ -6,6 +6,7 @@
 
 from models.domain.azuretremodel import AzureTREModel
 from models.domain.resource import Output, ResourceType
+from models.domain.authentication import User
 from resources import strings
 
 
@@ -92,7 +93,7 @@ class Operation(AzureTREModel):
     message: str = Field("", title="Additional operation status information")
     createdWhen: float = Field("", title="POSIX Timestamp for when the operation was submitted")
     updatedWhen: float = Field("", title="POSIX Timestamp for When the operation was updated")
-    user: dict = {}
+    user: User
     steps: Optional[List[OperationStep]] = Field(None, title="Operation Steps")
 
 

diff --git a/api_app/models/domain/resource.py b/api_app/models/domain/resource.py
@@ -2,6 +2,7 @@
 from typing import Optional, Union, List
 from pydantic import BaseModel, Field, field_validator
 from models.domain.azuretremodel import AzureTREModel
+from models.domain.authentication import User
 from models.domain.request_action import RequestAction
 from resources import strings
 
@@ -26,7 +27,7 @@ class ResourceHistoryItem(AzureTREModel):
     isEnabled: bool = True
     resourceVersion: int = 0
     updatedWhen: float = 0
-    user: dict = {}
+    user: User
     templateVersion: Optional[str] = Field(title="Resource template version", description="The version of the resource template (bundle) to deploy")
 
 
@@ -50,7 +51,7 @@ class Resource(AzureTREModel):
     etag: str = Field(None, title="_etag", description="eTag of the document", alias="_etag")
     resourcePath: str = ""
     resourceVersion: int = 0
-    user: dict = {}
+    user: Optional[User] = {}
     updatedWhen: float = 0
 
     def get_resource_request_message_payload(self, operation_id: str, step_id: str, action: RequestAction) -> dict:

diff --git a/api_app/models/domain/restricted_resource.py b/api_app/models/domain/restricted_resource.py
@@ -2,6 +2,7 @@
 from pydantic import Field
 from models.domain.resource import AvailableUpgrade, ResourceType
 from models.domain.azuretremodel import AzureTREModel
+from models.domain.authentication import User
 
 
 class RestrictedProperties(AzureTREModel):
@@ -27,5 +28,5 @@ class RestrictedResource(AzureTREModel):
     etag: str = Field(title="_etag", description="eTag of the document", alias="_etag")
     resourcePath: str = ""
     resourceVersion: int = 0
-    user: dict = {}
+    user: User
     updatedWhen: float = 0
diff --git a/api_app/models/schemas/airlock_request.py b/api_app/models/schemas/airlock_request.py
@@ -46,7 +46,7 @@ class AirlockRequestInResponse(BaseModel):
     airlockRequest: AirlockRequest
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "airlockRequest": get_sample_airlock_request("933ad738-7265-4b5f-9eae-a1a62928772e", "121e921f-a4aa-44b3-90a9-e8da030495ef")
             }
@@ -58,7 +58,7 @@ class AirlockRequestAndOperationInResponse(BaseModel):
     operation: Operation
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "airlockRequest": get_sample_airlock_request("933ad738-7265-4b5f-9eae-a1a62928772e", "121e921f-a4aa-44b3-90a9-e8da030495ef"),
                 "operation": get_sample_operation("121e921f-a4aa-44b3-90a9-e8da030495ef")
@@ -71,7 +71,7 @@ class AirlockRequestWithAllowedUserActions(BaseModel):
     allowedUserActions: List[str] = Field([], title="actions that the requesting user can do on the request")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": get_sample_airlock_request_with_allowed_user_actions("933ad738-7265-4b5f-9eae-a1a62928772e"),
         }
 
@@ -80,7 +80,7 @@ class AirlockRequestWithAllowedUserActionsInList(BaseModel):
     airlockRequests: List[AirlockRequestWithAllowedUserActions] = Field([], title="Airlock Requests")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "airlockRequests": [
                     get_sample_airlock_request_with_allowed_user_actions("933ad738-7265-4b5f-9eae-a1a62928772e"),
@@ -97,7 +97,7 @@ class AirlockRequestInCreate(BaseModel):
     properties: dict = Field({}, title="Airlock request parameters", description="Values for the parameters required by the Airlock request specification")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "type": "import",
                 "title": "a request title",
@@ -111,7 +111,7 @@ class AirlockReviewInCreate(BaseModel):
     decisionExplanation: str = Field("Decision Explanation", title="Explanation of the reviewer for the reviews decision")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "approval": "True",
                 "decisionExplanation": "the reason why this request was approved/rejected"

diff --git a/api_app/models/schemas/airlock_request_url.py b/api_app/models/schemas/airlock_request_url.py
@@ -11,7 +11,7 @@ class AirlockRequestTokenInResponse(BaseModel):
     containerUrl: str
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "container_url": get_sample_airlock_request_container_url("container_url")
             }

diff --git a/api_app/models/schemas/operation.py b/api_app/models/schemas/operation.py
@@ -33,7 +33,7 @@ class OperationInResponse(BaseModel):
     operation: Operation
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "operation": get_sample_operation("7ac667f0-fd3f-4a6c-815b-82d0cb7a2132")
             }
@@ -44,7 +44,7 @@ class OperationInList(BaseModel):
     operations: List[Operation] = Field([], title="Operations")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "operations": [
                     get_sample_operation("7ac667f0-fd3f-4a6c-815b-82d0cb7a2132"),

diff --git a/api_app/models/schemas/resource.py b/api_app/models/schemas/resource.py
@@ -11,7 +11,7 @@ class ResourcePatch(BaseModel):
 
     class Config:
         extra = Extra.forbid
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "isEnabled": False,
                 "templateVersion": "1.0.1",
@@ -45,7 +45,7 @@ class ResourceHistoryInList(BaseModel):
     resource_history: List[ResourceHistoryItem] = Field([], title="Resource history")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "resource_history": [
                     get_sample_resource_history("2fdc9fba-726e-4db6-a1b8-9018a2165748"),

diff --git a/api_app/models/schemas/resource_template.py b/api_app/models/schemas/resource_template.py
@@ -28,7 +28,7 @@ class ResourceTemplateInformationInList(BaseModel):
     templates: List[ResourceTemplateInformation]
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "templates": [
                     {

diff --git a/api_app/models/schemas/shared_service.py b/api_app/models/schemas/shared_service.py
@@ -25,7 +25,7 @@ class SharedServiceInResponse(BaseModel):
     sharedService: SharedService
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "shared_service": get_sample_shared_service("2fdc9fba-726e-4db6-a1b8-9018a2165748")
             }
@@ -36,7 +36,7 @@ class RestrictedSharedServiceInResponse(BaseModel):
     sharedService: RestrictedResource
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "shared_service": get_sample_shared_service("2fdc9fba-726e-4db6-a1b8-9018a2165748")
             }
@@ -47,7 +47,7 @@ class RestrictedSharedServicesInList(BaseModel):
     sharedServices: List[RestrictedResource] = Field([], title="shared services")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "sharedServices": [
                     get_sample_shared_service("2fdc9fba-726e-4db6-a1b8-9018a2165748"),
@@ -61,7 +61,7 @@ class SharedServicesInList(BaseModel):
     sharedServices: List[SharedService] = Field([], title="shared services")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "sharedServices": [
                     get_sample_shared_service("2fdc9fba-726e-4db6-a1b8-9018a2165748"),
@@ -76,7 +76,7 @@ class SharedServiceInCreate(BaseModel):
     properties: dict = Field({}, title="Shared service parameters", description="Values for the parameters required by the shared service resource specification")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "templateName": "tre-shared-service-firewall",
                 "properties": {

diff --git a/api_app/models/schemas/shared_service_template.py b/api_app/models/schemas/shared_service_template.py
@@ -38,7 +38,7 @@ def get_sample_shared_service_template_in_response() -> dict:
 
 class SharedServiceTemplateInCreate(ResourceTemplateInCreate):
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "name": "my-tre-shared-service",
                 "version": "0.0.1",
@@ -65,6 +65,6 @@ class Config:
 
 class SharedServiceTemplateInResponse(ResourceTemplateInResponse):
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": get_sample_shared_service_template_in_response()
         }
diff --git a/api_app/models/schemas/user_resource.py b/api_app/models/schemas/user_resource.py
@@ -29,7 +29,7 @@ class UserResourceInResponse(BaseModel):
     userResource: UserResource
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "user_resource": get_sample_user_resource("933ad738-7265-4b5f-9eae-a1a62928772e")
             }
@@ -40,7 +40,7 @@ class UserResourcesInList(BaseModel):
     userResources: List[UserResource] = Field([], title="User resources")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "userResources": [
                     get_sample_user_resource("2fdc9fba-726e-4db6-a1b8-9018a2165748"),
@@ -55,7 +55,7 @@ class UserResourceInCreate(BaseModel):
     properties: dict = Field({}, title="User resource parameters", description="Values for the parameters required by the user resource specification")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "templateName": "user-resource-type",
                 "properties": {

diff --git a/api_app/models/schemas/user_resource_template.py b/api_app/models/schemas/user_resource_template.py
@@ -38,7 +38,7 @@ def get_sample_user_resource_template_in_response() -> dict:
 class UserResourceTemplateInCreate(ResourceTemplateInCreate):
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "name": "my-tre-user-resource",
                 "version": "0.0.1",
@@ -71,6 +71,6 @@ class UserResourceTemplateInResponse(ResourceTemplateInResponse):
     parentWorkspaceService: str = Field(title="Workspace type", description="Bundle name")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": get_sample_user_resource_template_in_response()
         }
diff --git a/api_app/models/schemas/users.py b/api_app/models/schemas/users.py
@@ -8,7 +8,7 @@ class UsersInResponse(BaseModel):
     users: List[User] = Field(..., title="Users", description="List of users assigned to the workspace")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "users": [
                     {

diff --git a/api_app/models/schemas/workspace.py b/api_app/models/schemas/workspace.py
@@ -39,7 +39,7 @@ class WorkspaceInResponse(BaseModel):
     workspace: Workspace
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "workspace": get_sample_workspace("933ad738-7265-4b5f-9eae-a1a62928772e")
             }
@@ -50,7 +50,7 @@ class WorkspaceAuthInResponse(BaseModel):
     workspaceAuth: WorkspaceAuth
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "scopeId": "api://mytre-ws-1233456"
             }
@@ -61,7 +61,7 @@ class WorkspacesInList(BaseModel):
     workspaces: List[Workspace]
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "workspaces": [
                     get_sample_workspace("933ad738-7265-4b5f-9eae-a1a62928772e", "0001"),
@@ -76,7 +76,7 @@ class WorkspaceInCreate(BaseModel):
     properties: dict = Field(None, title="Workspace parameters", description="Values for the parameters required by the workspace resource specification")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "templateName": "tre-workspace-base",
                 "properties": {

diff --git a/api_app/models/schemas/workspace_service.py b/api_app/models/schemas/workspace_service.py
@@ -24,7 +24,7 @@ class WorkspaceServiceInResponse(BaseModel):
     workspaceService: WorkspaceService
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "workspace_service": get_sample_workspace_service("933ad738-7265-4b5f-9eae-a1a62928772e", "2fdc9fba-726e-4db6-a1b8-9018a2165748")
             }
@@ -35,7 +35,7 @@ class WorkspaceServicesInList(BaseModel):
     workspaceServices: List[WorkspaceService] = Field([], title="Workspace services")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "workspaceServices": [
                     get_sample_workspace_service("933ad738-7265-4b5f-9eae-a1a62928772e", "2fdc9fba-726e-4db6-a1b8-9018a2165748"),
@@ -50,7 +50,7 @@ class WorkspaceServiceInCreate(BaseModel):
     properties: dict = Field({}, title="Workspace service parameters", description="Values for the parameters required by the workspace service resource specification")
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "templateName": "tre-service-guacamole",
                 "properties": {

diff --git a/api_app/models/schemas/workspace_service_template.py b/api_app/models/schemas/workspace_service_template.py
@@ -39,7 +39,7 @@ def get_sample_workspace_service_template_in_response() -> dict:
 class WorkspaceServiceTemplateInCreate(ResourceTemplateInCreate):
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "name": "my-tre-workspace-service",
                 "version": "0.0.1",
@@ -67,6 +67,6 @@ class Config:
 class WorkspaceServiceTemplateInResponse(ResourceTemplateInResponse):
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": get_sample_workspace_service_template_in_response()
         }
diff --git a/api_app/models/schemas/workspace_template.py b/api_app/models/schemas/workspace_template.py
@@ -43,7 +43,7 @@ def get_sample_workspace_template_in_response() -> dict:
 class WorkspaceTemplateInCreate(ResourceTemplateInCreate):
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": {
                 "name": "my-tre-workspace",
                 "version": "0.0.1",
@@ -95,6 +95,6 @@ class Config:
 class WorkspaceTemplateInResponse(ResourceTemplateInResponse):
 
     class Config:
-        json_schema_extra = {
+        schema_extra = {
             "example": get_sample_workspace_template_in_response()
         }