Skip to content

Enhancing Medusa with an Interactive FastAPI Microservice #175

@badreddine2

Description

@badreddine2

Enhancing Medusa with an Interactive FastAPI Microservice

This contribution aims to extend the functionality of Medusa by implementing a microservice using FastAPI.

The goal is to:

  • Make Medusa interactive and user-friendly.
  • Provide an API interface with Swagger documentation.
  • Reduce reliance on terminal commands.

Proposed Features

1. Add move and copy Functionalities

  • Move: Transfer secrets from one path to another, deleting them from the source.
  • Copy: Duplicate secrets from one path to another without altering the source.

2. Containerized Medusa Microservice

  • Build a Docker container for the FastAPI microservice.
  • Expose all functionalities via:
    • Fast API Swagger .

3. Enhanced Import Functionality

  • Allow importing multiple files (YAML/JSON) in one operation.
  • Support importing an entire directory of files.

4. Improved Export Functionality

  • Display all available secrets in a selectable list.
  • Export selected secrets into separate files with a naming convention (default: YAML).

5. Comprehensive Documentation

  • Clear explanation of:
    • New endpoints and their usage.
    • Interaction examples using Swagger UI and API clients.
  • Setup and run instructions for the Docker container.

Benefits of the Contribution

  • Interactive and User-Friendly:
    Simplifies secret management by replacing CLI commands.

  • Time-Saving Bulk Operations:
    Improved import/export functionalities for multiple secrets.

  • Improved Workflow Integration:
    Easy to integrate into workflows with API and containerized setup.

  • Well-Documented:
    Ensures a smooth onboarding process for users and contributors.


Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions