Remove sort order, rename ucs stuff to be generic, various doc string and comment fixes

Author: TheByronHimes

.devcontainer/.dev_config.yaml

@@ -4,7 +4,7 @@ mongo_dsn: mongodb://localhost:27017
 db_name: uos
 mongo_timeout: 300
 auth_key: "{}"
-ucs_url: http://127.0.0.1/upload
+file_box_service_url: http://127.0.0.1/upload
 access_url: http://127.0.0.1/access
 audit_record_topic: audit-records
 audit_record_type: audit_record_logged

README.md

@@ -94,7 +94,7 @@ The service requires the following configuration parameters:
   ```
 
 
-- <a id="properties/ucs_url"></a>**`ucs_url`** *(string, required)*: URL pointing to the UCS API.
+- <a id="properties/file_box_service_url"></a>**`file_box_service_url`** *(string, format: uri, required)*: URL pointing to the API of the service that owns FileUploadBoxes (currently the UCS). Length must be between 1 and 2083 (inclusive).
 
 
   Examples:
@@ -114,7 +114,7 @@ The service requires the following configuration parameters:
   ```
 
 
-- <a id="properties/access_url"></a>**`access_url`** *(string, required)*: URL pointing to the internal access API.
+- <a id="properties/access_url"></a>**`access_url`** *(string, format: uri, required)*: URL pointing to the internal access API. Length must be between 1 and 2083 (inclusive).
 
 
   Examples:

config_schema.json

@@ -35,12 +35,15 @@
       "title": "Audit Record Type",
       "type": "string"
     },
-    "ucs_url": {
-      "description": "URL pointing to the UCS API.",
+    "file_box_service_url": {
+      "description": "URL pointing to the API of the service that owns FileUploadBoxes (currently the UCS).",
       "examples": [
         "http://127.0.0.1/upload"
       ],
-      "title": "Ucs Url",
+      "format": "uri",
+      "maxLength": 2083,
+      "minLength": 1,
+      "title": "File Box Service Url",
       "type": "string"
     },
     "work_order_signing_key": {
@@ -58,6 +61,9 @@
       "examples": [
         "http://127.0.0.1/access"
       ],
+      "format": "uri",
+      "maxLength": 2083,
+      "minLength": 1,
       "title": "Access Url",
       "type": "string"
     },
@@ -494,7 +500,7 @@
     "file_upload_box_topic",
     "audit_record_topic",
     "audit_record_type",
-    "ucs_url",
+    "file_box_service_url",
     "work_order_signing_key",
     "access_url",
     "service_instance_id",

example_config.yaml

@@ -21,6 +21,7 @@ cors_exposed_headers: null
 db_name: uos
 docs_url: /docs
 enable_opentelemetry: false
+file_box_service_url: http://127.0.0.1/upload
 file_upload_box_topic: file-upload-boxes
 generate_correlation_id: true
 host: 127.0.0.1
@@ -48,6 +49,5 @@ port: 8080
 research_data_upload_box_topic: research-data-upload-boxes
 service_instance_id: '1'
 service_name: uos
-ucs_url: http://127.0.0.1/upload
 work_order_signing_key: '**********'
 workers: 1

openapi.yaml

@@ -19,28 +19,6 @@ components:
       - boxes
       title: BoxRetrievalResults
       type: object
-    ClaimValidity:
-      description: Start and end dates for validating claims.
-      properties:
-        valid_from:
-          description: Start date of validity
-          examples:
-          - '2023-01-01T00:00:00Z'
-          format: date-time
-          title: Valid From
-          type: string
-        valid_until:
-          description: End date of validity
-          examples:
-          - '2023-12-31T23:59:59Z'
-          format: date-time
-          title: Valid Until
-          type: string
-      required:
-      - valid_from
-      - valid_until
-      title: ClaimValidity
-      type: object
     CreateUploadBoxRequest:
       description: Request model for creating a new research data upload box.
       properties:
@@ -83,14 +61,36 @@ components:
           title: User Id
           type: string
         validity:
-          $ref: '#/components/schemas/ClaimValidity'
+          $ref: '#/components/schemas/GrantValidity'
       required:
       - validity
       - user_id
       - iva_id
       - box_id
       title: GrantAccessRequest
       type: object
+    GrantValidity:
+      description: Start and end dates for validating grants.
+      properties:
+        valid_from:
+          description: Start date of validity
+          examples:
+          - '2023-01-01T00:00:00Z'
+          format: date-time
+          title: Valid From
+          type: string
+        valid_until:
+          description: End date of validity
+          examples:
+          - '2023-12-31T23:59:59Z'
+          format: date-time
+          title: Valid Until
+          type: string
+      required:
+      - valid_from
+      - valid_until
+      title: GrantValidity
+      type: object
     GrantWithBoxInfo:
       description: An UploadGrant with the ResearchDataUploadBox title and description.
       properties:
@@ -197,7 +197,7 @@ components:
           title: File Count
           type: integer
         file_upload_box_id:
-          description: The ID of the file upload box.
+          description: The ID of the corresponding file upload box.
           format: uuid4
           title: File Upload Box Id
           type: string
@@ -251,13 +251,6 @@ components:
       - closed
       title: ResearchDataUploadBoxState
       type: string
-    SortOrder:
-      description: Represents the possible sorting orders
-      enum:
-      - ascending
-      - descending
-      title: SortOrder
-      type: string
     UpdateUploadBoxRequest:
       description: Request model for updating a research data upload box.
       properties:
@@ -464,14 +457,6 @@ paths:
           - type: 'null'
           description: Maximum number of research data upload boxes to return
           title: Limit
-      - description: Sort order(s) that shall be used when sorting results
-        in: query
-        name: sort
-        required: false
-        schema:
-          $ref: '#/components/schemas/SortOrder'
-          default: ascending
-          description: Sort order(s) that shall be used when sorting results
       responses:
         '200':
           content:

scripts/compare_class_defs.py

@@ -19,10 +19,10 @@
 import inspect
 
 # Import the abstract base classes and their implementations
-from uos.adapters.outbound.http import AccessClient, UCSClient  # noqa: F401
+from uos.adapters.outbound.http import AccessClient, FileBoxClient  # noqa: F401
 from uos.core.orchestrator import UploadOrchestrator  # noqa: F401
 from uos.ports.inbound.orchestrator import UploadOrchestratorPort
-from uos.ports.outbound.http import AccessClientPort, UCSClientPort
+from uos.ports.outbound.http import AccessClientPort, FileBoxClientPort
 
 
 def print_links(abc_method: type, imp_method: type):
@@ -68,7 +68,7 @@ def check_implementation(abc_class: type):
 
 def main():
     """Test me"""
-    ports = [AccessClientPort, UCSClientPort, UploadOrchestratorPort]
+    ports = [AccessClientPort, FileBoxClientPort, UploadOrchestratorPort]
     for port in ports:
         check_implementation(port)
 

src/uos/adapters/inbound/__init__.py

@@ -13,5 +13,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Subpackage defining a inbound/primary/driving adapters according to the
+"""Subpackage defining inbound/primary/driving adapters according to the
 Hexagonal Architecture Concept."""

src/uos/adapters/inbound/event_sub.py

@@ -63,7 +63,7 @@ async def changed(self, resource_id: str, update: FileUploadBox) -> None:
         await self._upload_orchestrator.upsert_file_upload_box(file_upload_box=update)
 
     async def deleted(self, resource_id: str) -> None:
-        """Consume a deleted FileUploadBox event and remove from own storage"""
+        """Consume a deleted FileUploadBox event -- these don't exist and are ignored"""
         log.warning(
             "Encountered 'deleted' event for FileUploadBox %s. Ignoring.", resource_id
         )

src/uos/adapters/inbound/fastapi_/dummies.py

@@ -36,7 +36,7 @@
 ]
 
 auth_provider = DependencyDummy("auth_provider")
-upload_orchestrator_port = DependencyDummy("work_package_repo_port")
+upload_orchestrator_port = DependencyDummy("upload_orchestrator_port")
 
 AuthProviderDummy = Annotated[AuthContextProtocol[AuthContext], Depends(auth_provider)]
 UploadOrchestratorDummy = Annotated[

src/uos/adapters/inbound/fastapi_/http_exceptions.py

@@ -102,20 +102,18 @@ class DataModel(BaseModel):
 
         skip: int | None
         limit: int | None
-        sort: str
 
     def __init__(
         self,
         *,
         message: str = "There was a problem with the supplied pagination parameters.",
         skip: int | None,
         limit: int | None,
-        sort: str,
         status_code: int = 422,
     ):
         """Construct message and init the exception."""
         super().__init__(
             status_code=status_code,
             description=message,
-            data={"skip": skip, "limit": limit, "sort": sort},
+            data={"skip": skip, "limit": limit},
         )