Skip to content

Releases: GLEIF-IT/reg-pilot-filer

v0.1.0 - Enhanced Role Validation and Streamlined Verifier Integration

28 Jan 00:37
410c049
Compare
Choose a tag to compare

🚀 Release Notes - Filer v0.1.0

Release Date: 2025-01-28
Tag: v0.1.0
Title: Enhanced Role Validation and Integration with vLEI Verifier Client


✨ New Features

🔒 Role Validation

  • Integrated Business Logic for Role Validation:
    • The Filer now validates user roles to ensure proper authorization.
    • This functionality was previously handled by the Verifier service but has been transitioned to the Filer for improved modularity and operational focus.

📦 Integration with vlei-verifier-client

  • The Filer now uses the vlei-verifier-client package:
    • Provides a standardized and simplified interface for interacting with the vLEI Verifier.
    • Reduces the need for direct HTTP requests to the Verifier service.

🛠️ How to Upgrade

To upgrade to this version:

  1. Update your Filer service dependencies to include the latest vlei-verifier-client package:
    pip install -r requirements.txt

📌 Summary

This release strengthens the Filer's capabilities by adding role validation business logic and streamlining interactions with the vLEI Verifier via the official client library.

0.0.2 - Role-Based Configuration and Data Admin features

20 Jan 17:42
31d9440
Compare
Choose a tag to compare

🚀 Release Notes - Filer v0.0.2

Release Date: 2025-01-06
Tag: v0.0.2
Title: Enhanced Role-Based Configuration and New Report Status Endpoint


✨ New Features

🔧 Configurable Parameters

  • Role-Based Verification Enhancements:
    • admin_role_name:
      Defines the name of the Data Admin role, ensuring that the Engagement Context Role (ECR) credential corresponds to the expected Data Admin credential.
    • admin_lei:
      Specifies the Legal Entity Identifier (LEI) linked to the Data Admin credential, allowing for precise validation of ECR credentials.

🌐 New Endpoints

  • /reports/status/{aid}/{lei}:
    • Purpose: Enables Data Admins to retrieve upload statuses for submitted reports.
    • Features:
      • Query upload statuses by Admin Identifier (AID).
      • Optionally filter results by Legal Entity Identifier (LEI).
      • If no LEI is provided, statuses for all uploads will be returned.

🛠️ How to Use

Example Request for /reports/status/{aid}/{lei}:

  • GET /reports/status/12345/67890
    Retrieves the upload statuses for reports submitted by the Data Admin AID 12345 and associated with the LEI 67890.

  • GET /reports/status/12345
    Retrieves all upload statuses for reports submitted by the Data Admin AID 12345.


📌 Summary

This release introduces enhanced support for Data Admin roles through configurable parameters and a new endpoint for managing report statuses. These updates improve role-based access and operational efficiency for Data Admin users.

0.0.1 - Initial Release with Enhanced LMDB Handling and Configurable Parameters

20 Jan 17:38
aac2ffe
Compare
Choose a tag to compare

🚀 Release Notes - Filer v0.0.1

Release Date: 2025-01-08
Tag: v0.0.1
Title: Enhanced Configuration Flexibility and Automatic Cleanup


✨ New Features

⚙️ Configurable Environment Variables

  • Resource and Performance Management:

    • KERI_BASER_MAP_SIZE: Defines the maximum size of the LMDB database. Defaults to 104857600 (100 MB).
    • FILER_CHUNK_SIZE: Configures the size of chunks used for file processing, optimizing memory usage for handling large files.
  • Service Configuration:

    • VLEI_VERIFIER: Specifies the base URL of the Vlei Verifier.

🗑️ Automatic LMDB Cleanup

  • Optimized Database Usage:
    • Processed reports are now automatically removed from the LMDB database after verification, preventing database size issues.

🛠️ How to Run

To start the Filer service, use the following command:

reg-pilot-filer server start --config-dir scripts --config-file reg-pilot-filer-config.json