README.md

🌟 Cloud-Barista API Documentation Hub

Welcome to the centralized API documentation portal for the Cloud-Barista ecosystem! This repository provides comprehensive API documentation for all Cloud-Barista projects, powered by Swagger UI and hosted on GitHub Pages.

📋 Table of Contents

• 🚀 Introduction
• 📖 How to Use
• 🔗 Core Platform Projects
• 📞 Support & Contributing

🚀 Introduction

⚠️ Note: Cloud-Barista is under active development (pre-v1.0) and is not yet stable or secure for production use.

Each project lists API documentation for the latest development branch as well as the two most recent stable releases, updated automatically every day.

Get Involved: Found an issue or have an idea? Please open an issue or connect with us on Slack. We welcome your feedback!

📖 How to Use

Method 1: Direct Access

Click on any API documentation link below to view the Swagger UI directly.

Method 2: Custom URL

Use the URL format below to view any Swagger specification hosted on GitHub:

https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/{org}/{repo}/{ref}/path/to/swagger.yaml

---

🔗 Core Platform Projects

CB-Spider

• Repository: https://github.com/cloud-barista/cb-spider

• API Documentation:
  • latest dev (master)
  • v0.12.15
  • v0.12.14

• Releases: https://github.com/cloud-barista/cb-spider/releases

CB-Tumblebug

• Repository: https://github.com/cloud-barista/cb-tumblebug

• API Documentation:
  • latest dev (main)
  • v0.12.6
  • v0.12.5

• Releases: https://github.com/cloud-barista/cb-tumblebug/releases

CM-Honeybee

• Repository: https://github.com/cloud-barista/cm-honeybee

• API Documentation:
  • Agent:
    • latest dev (main)
    • v0.5.0
    • v0.4.1
  • Server:
    • latest dev (main)
    • v0.5.0
    • v0.4.1

• Releases: https://github.com/cloud-barista/cm-honeybee/releases

CM-Beetle

• Repository: https://github.com/cloud-barista/cm-beetle

• API Documentation:
  • latest dev (main)
  • v0.5.0
  • v0.4.7

• Releases: https://github.com/cloud-barista/cm-beetle/releases

CM-Grasshopper

• Repository: https://github.com/cloud-barista/cm-grasshopper

• API Documentation:
  • latest dev (main)
  • v0.5.0
  • v0.4.2

• Releases: https://github.com/cloud-barista/cm-grasshopper/releases

CM-Damselfly

• Repository: https://github.com/cloud-barista/cm-damselfly

• API Documentation:
  • latest dev (main)
  • v0.5.0
  • 0.4.1

• Releases: https://github.com/cloud-barista/cm-damselfly/releases

CM-Cicada

• Repository: https://github.com/cloud-barista/cm-cicada

• API Documentation:
  • latest dev (main)
  • v0.5.0
  • v0.4.2

• Releases: https://github.com/cloud-barista/cm-cicada/releases

CM-Ant

• Repository: https://github.com/cloud-barista/cm-ant

• API Documentation:
  • latest dev (main)
  • v0.5.0
  • v0.4.1

• Releases: https://github.com/cloud-barista/cm-ant/releases

CM-Butterfly

• Repository: https://github.com/cloud-barista/cm-butterfly
• API Documentation: Not available (no REST API specification)
• Releases: https://github.com/cloud-barista/cm-butterfly/releases

CM-Mayfly

• Repository: https://github.com/cloud-barista/cm-mayfly
• API Documentation: Not available (no REST API specification)
• Releases: https://github.com/cloud-barista/cm-mayfly/releases

mc-data-manager

• Repository: https://github.com/cloud-barista/mc-data-manager

• API Documentation:
  • latest dev (main)
  • v0.5.3
  • v0.5.2

• Releases: https://github.com/cloud-barista/mc-data-manager/releases

mc-terrarium

• Repository: https://github.com/cloud-barista/mc-terrarium

• API Documentation:
  • latest dev (main)
  • v0.1.4
  • v0.1.3

• Releases: https://github.com/cloud-barista/mc-terrarium/releases

---

📞 Support & Contributing

• Organization: Cloud-Barista
• Issues: Report issues in the respective project repositories
• Contributing: Check individual project repositories for contribution guidelines
• Community: Join our discussions and stay updated with the latest developments