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.