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
3 changes: 3 additions & 0 deletions .github/workflows/e2e-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ jobs:
- suite: rust-docker
cmd: "mise run --no-deps --skip-deps e2e:rust"
apt_packages: "openssh-client"
- suite: supervisor-middleware
cmd: "mise run --no-deps --skip-deps e2e:supervisor-middleware"
apt_packages: "openssh-client"
- suite: mcp
cmd: "mise run --no-deps --skip-deps e2e:mcp"
apt_packages: ""
Expand Down
1 change: 1 addition & 0 deletions Cargo.lock

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

9 changes: 9 additions & 0 deletions crates/openshell-sdk/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,26 @@ rust-version.workspace = true
license.workspace = true
repository.workspace = true

[features]
default = []
extension = [
"dep:jsonwebtoken",
"dep:serde_json",
]

[dependencies]
openshell-core = { path = "../openshell-core" }
async-trait = "0.1"
futures = { workspace = true }
hyper = { workspace = true }
hyper-util = { workspace = true }
jsonwebtoken = { workspace = true, optional = true }
miette = { workspace = true }
oauth2 = { version = "5", default-features = false, features = ["reqwest"] }
reqwest = { workspace = true }
rustls = { workspace = true }
serde = { workspace = true }
serde_json = { workspace = true, optional = true }
thiserror = { workspace = true }
tokio = { workspace = true }
tokio-rustls = { workspace = true }
Expand Down
12 changes: 12 additions & 0 deletions crates/openshell-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,17 @@ mTLS (client certificates) is not supported.
SDK-shaped enums rather than raw proto integers. Failures map to a typed
`SdkError` with a discriminable kind.

Enable the `extension` Cargo feature when building an OpenShell extension
service:

```toml
openshell-sdk = { version = "...", features = ["extension"] }
```

The `extension` module provides common SDK building blocks for extension
services. It currently handles caller verification; shared service interfaces
and observability support will follow.

## Modules

| Module | Purpose |
Expand All @@ -60,6 +71,7 @@ SDK-shaped enums rather than raw proto integers. Failures map to a typed
| `oidc` | OIDC token handling at the transport layer. |
| `refresh` | `Refresh` trait and single-flight refresh coalescing. |
| `edge_tunnel` | Cloudflare Access tunnel dialer. |
| `extension` | Opt-in SDK building blocks for extension services. |
| `error` | `SdkError` taxonomy. |
| `types` | Curated request/response types and proto conversions. |
| `raw` | Escape hatch re-exporting the generated tonic clients. |
Expand Down
Loading
Loading