Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/bcs/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions src/bcs/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ members = [
"crates/services/bcs-friend-store",
"crates/services/bcs-group",
"crates/application/v1/bcs-app-group",
"crates/application/v1/bcs-app-bot",
"crates/services/bcs-group-store",
"crates/services/bcs-message",
"crates/services/bcs-message-flow",
Expand Down Expand Up @@ -227,6 +228,7 @@ bcs-collaboration-store = { path = "crates/services/bcs-collaboration-store" }
bcs-judge = { path = "crates/services/bcs-judge" }
bcs-jwt = { path = "crates/services/bcs-jwt" }
bcs-group = { path = "crates/services/bcs-group" }
bcs-app-bot = { path = "crates/application/v1/bcs-app-bot" }
bcs-app-group = { path = "crates/application/v1/bcs-app-group" }
bcs-group-store = { path = "crates/services/bcs-group-store" }
bcs-message = { path = "crates/services/bcs-message" }
Expand Down
24 changes: 17 additions & 7 deletions src/bcs/api-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,23 @@
models and resource path items live in separate YAML fragments so a domain can
evolve without creating one monolithic file.

The first implementation batch contains exactly five Group operations:
The current contract contains 32 approved operations across Bot, Group,
GroupParticipant, Session, SessionParticipant, Invitation, Friendship, and
FriendRequest resources.

- `GET /openapi/v1/bots/collaboration/{bot_uuid}/groups`
- `POST /openapi/v1/groups`
- `GET /openapi/v1/groups/{group_id}`
- `PATCH /openapi/v1/groups/{group_id}`
- `DELETE /openapi/v1/groups/{group_id}`
The Human control-plane Bot batch contains exactly five operations:

- `GET /openapi/v1/bots/{bot_id}/candidates`
- `POST /openapi/v1/bots/query`
- `GET /openapi/v1/bots/{bot_id}`
- `PATCH /openapi/v1/bots/{bot_id}`
- `GET /openapi/v1/bots/mine`

These operations deliberately do not add generic `GET /bots`, legacy
`/actors/**` aliases, runtime discovery, or a separate descriptor patch route.
All five require a Human Principal. The Bot domain object is discriminated by
`kind=bot|human`; omission of a `kind` query filter means both kinds rather
than a synthetic `all` enum value.

Validate the contract:

Expand All @@ -33,7 +43,7 @@ dependencies:

```bash
uv run --with pytest --with pyyaml \
pytest src/bcs/tests/openapi/test_group_v1_contract.py -q
pytest src/bcs/tests/openapi -q
```

Generated files are build artifacts and are not committed. The candidate YAML
Expand Down
Loading