Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
phodal committed Aug 15, 2023
1 parent afed1c1 commit 5121021
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 9 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,26 @@ features:
- design for new service.
- share for code copy.

modules:
## APIs

### TEXT EMBEDDING

GET http://127.0.0.1:8765/api/text-embedding?q="create arch system"

### Query API

GET http://127.0.0.1:8765/api/query?q="create arch system"&repo_ref=archguard&query_type=HttpApi

### Upload Data by ArchGuard

POST http://127.0.0.1:8765/scanner/:systemId/reporting/class-items

POST http://127.0.0.1:8765/scanner/:systemId/reporting/openapi

POST http://127.0.0.1:8765/scanner/:systemId/reporting/container-services

POST http://127.0.0.1:8765/scanner/:systemId/reporting/datamap-relations

- CoUnit Client
- CoUnit Server
- CoUnit Index

## License

Expand Down
4 changes: 3 additions & 1 deletion counit-server/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ stardict_wrapper = "0.0.5"

# third party
# the open api spec
utoipa = "3"
utoipa = { version = "3", features = ["axum_extras"] }
# utoipa-swagger-ui
utoipa-swagger-ui = { version = "3", eatures = ["axum"] }

# embedding
ort = { git = "https://github.com/bloopai/ort", branch = "env-builder-telemetry" }
Expand Down
14 changes: 10 additions & 4 deletions counit-server/counit-server.http
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,18 @@ Content-Type: application/json
### TEXT EMBEDDING
GET http://127.0.0.1:8765/api/text-embedding?q="create arch system"

### Query
GET http://127.0.0.1:8765/api/query?q=""&repo_ref=mall

### Query API
GET http://127.0.0.1:8765/api/query?q="create arch system"&repo_ref=archguard&query_type=HttpApi
// query_type Code`, `Comment`, `Doc`, `HttpApi`

### Upload Data by ArchGuard

POST http://127.0.0.1:8765/scanner/:systemId/reporting/class-items

POST http://127.0.0.1:8765/scanner/:systemId/reporting/openapi

POST http://127.0.0.1:8765/scanner/:systemId/reporting/container-services

POST http://127.0.0.1:8765/scanner/:systemId/reporting/datamap-relations


## Swagger
Expand Down

0 comments on commit 5121021

Please sign in to comment.