v0.1.0 - Streamlined Verifier Integration with vLEI Verifier Client

🚀 Release Notes - reg-pilot-api v0.1.0

Release Date: 2025-01-27
Tag: v0.1.0
Title: Streamlined Verifier Integration with vLEI Verifier Client

---

✨ What's Changed

🔄 Improved Verifier Integration

• The reg-pilot-api now leverages the vlei-verifier-client library for verifier interactions, replacing direct API calls to the vLEI Verifier.
• This change improves maintainability and reliability by utilizing an established library for all interactions with the verifier service.

---

📌 Summary

This release enhances the reg-pilot-api by adopting the vlei-verifier-client library, streamlining verifier-related interactions and ensuring better scalability and ease of maintenance.

0.0.3

✨ Release Notes - Reg-Pilot-API v0.0.3

Release Date: 2025-01-21
Tag: v0.0.3
Title: Enhanced Security for /checklogin Requests

---

✨ New Features

🔒 Signed Headers Check for /checklogin

• The /checklogin endpoint now requires the inclusion of signed headers.
  • Mandatory headers:
    • signature
    • signature-input
    • signify-resource
    • signify-timestamp
  • Requests without these headers will be rejected with an appropriate error message.

---

🔧 How to Run

To run the Reg-Pilot-API service:

Locally

After building the project locally (e.g., python -m pip install -e .):

python src/regps/app/fastapi_app.py

Using Docker

docker-compose down
docker-compose up

---

🔎 Testing the /checklogin Endpoint

You can test the endpoint using Swagger by navigating to:

http://127.0.0.1:8000/docs

Ensure the signed headers are included in the request payload to validate the new functionality.

---

🗋 Summary

This release introduces a signed headers requirement for the /checklogin endpoint.

0.0.2 - Initial Release of Reg-Pilot-API Service

🚀 Release Notes - Reg-Pilot-API v0.0.2

Release Date: 2025-01-20
Tag: v0.0.2
Title: Initial Release of Reg-Pilot-API Service

---

✨ Key Features

🎯 Core Functionality

The Reg-Pilot-API service is designed to manage requests and responses for the regulator portal with key features including:

• User Authentication: Log in using vLEI ECR credentials for secure access.
• Report Submission: Upload signed reports securely to the service.
• Upload Status Tracking: Check the status of previously submitted reports.

🔧 Deployment Options

Local Development

• Run the service locally after building the project with:

  python -m pip install -e .
  python src/regps/app/fastapi_app.py

Docker Deployment

• Quickly set up the service using Docker Compose:

  docker-compose down
  docker-compose up

---

🔗 Integration with Other Services

Webapp

• The front-end application leverages Signify/KERIA for selecting identifiers and credentials.
• Repository: reg-pilot-webapp

Verifier

• Uses keripy for validating requests.
• Repository: vlei-verifier

Filer

• Manages report uploads for the portal.
• Repository: reg-pilot-filer

Additional Services

• KERI Witness Network
• vLEI Verifier
• KERI Agent

---

🔧 REST API

Test queries and explore available endpoints using Swagger:

• Visit: http://127.0.0.1:8000/docs

---

📌 Summary

This release marks the foundation of the Reg-Pilot-API service, offering a secure, scalable, and efficient solution for managing credentials authentication, report uploads, and validation processes using the vlei-verifier and reg-pilot-filer.

Legacy Version with Centralized vLEI Verifier File Handling

Release Notes - reg-pilot-api (Legacy Version)

Release Date: Legacy Version
Title: Initial Version with vLEI Verifier File Handling

---

✨ What's Included

🗂️ File Upload Handling

• All file upload operations are managed directly by the vLEI Verifier service.
• This version lacks integration with the Filer service for handling report uploads, resulting in a more centralized verifier-dependent architecture.

🔐 Authentication

• Supports authentication via vLEI ECR credentials, ensuring that only authorized users can access the service.

📊 Status Checking

• Provides APIs to check the status of uploaded files directly via the vLEI Verifier.

---

🚨 Limitations in the Legacy Version

• No Support for Filer: File uploads are directly tied to the verifier, resulting in limited flexibility for managing uploads.
• Tight Coupling: The architecture directly relies on the verifier for file processing, which may lead to reduced scalability.

---

📌 Summary

This legacy version provides basic functionality for authentication, file uploads, and status checking by utilizing the vLEI Verifier as the central service. Users seeking improved scalability and modularity should consider upgrading to later versions with Filer integration.