forked from cloud-barista/api
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
04e6256
commit 6cb3cf4
Showing
1 changed file
with
6 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,18 @@ | ||
| # API documentation for Cloud-Barista subsystems | ||
| # API documentation | ||
|
|
||
| Through this repository, we will provide API documentation for Cloud-Barista subsystems. | ||
| Through this repository, we will provide API documentation. | ||
| Swagger UI is hosted on GitHub Pages. | ||
|
|
||
| Note - The latest API documentation is provided (under development). | ||
| Please, take a look at subsystems for stable versions. | ||
|
|
||
| ## CB-Spider | ||
| * Repository: https://github.com/cloud-barista/cb-spider | ||
| * API documentation: https://github.com/cloud-barista/cb-spider/wiki/CB-Spider-User-Interface#cb-spider-rest-api-documents-and-guide | ||
|
|
||
| ## CB-Tumblebug | ||
|
|
||
| * Repository: https://github.com/cloud-barista/cb-tumblebug | ||
| * API documentation: https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/cb-tumblebug/main/src/api/rest/docs/swagger.yaml | ||
|
|
||
| ## CM-Honeybee | ||
|
|
||
| * Repository: https://github.com/cloud-barista/cm-honeybee | ||
| * API documentation: | ||
| - Agent: https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/cm-honeybee/main/agent/pkg/api/rest/docs/swagger.yaml | ||
| - Server: https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/cm-honeybee/main/server/pkg/api/rest/docs/swagger.yaml | ||
|
|
||
| ## CM-Beetle | ||
|
|
||
| * Repository: https://github.com/cloud-barista/cm-beetle | ||
| * API documentation: https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/cm-beetle/main/api/swagger.yaml | ||
|
|
||
| ## CM-Grasshopper | ||
|
|
||
| * Repository: https://github.com/cloud-barista/cm-grasshopper | ||
| * API documentation: https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/cm-grasshopper/main/pkg/api/rest/docs/swagger.yaml | ||
|
|
||
| ## CM-Damselfly | ||
|
|
||
| * Repository: https://github.com/cloud-barista/cm-damselfly | ||
| * API documentation: N/A | ||
|
|
||
| ## CM-Cicada | ||
|
|
||
| * Repository: https://github.com/cloud-barista/cm-cicada | ||
| * API documentation: https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/cm-cicada/main/pkg/api/rest/docs/swagger.yaml | ||
|
|
||
| ## CM-Ant | ||
|
|
||
| * Repository: https://github.com/cloud-barista/cm-ant | ||
| * API documentation: https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/cm-ant/main/api/swagger.yaml | ||
|
|
||
|
|
||
| ## CM-Mayfly | ||
|
|
||
| * Repository: https://github.com/cloud-barista/cm-mayfly | ||
| * API documentation: N/A | ||
| ## CB-Spider | ||
| * Repository: https://github.com/cloud-barista/cb-spider | ||
| * API documentation: https://github.com/cloud-barista/cb-spider/wiki/CB-Spider-User-Interface#cb-spider-rest-api-documents-and-guide | ||
|
|
||
| ## CM-Butterfly | ||
| * Repository: https://github.com/cloud-barista/cm-butterfly | ||
| * API documentation: N/A | ||
| ++ TBD |