consolidation of some of the modules, localization fixes, product advisories work, qa work
This commit is contained in:
49
docs-archived/modules/sdk/README.md
Normal file
49
docs-archived/modules/sdk/README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# SDK
|
||||
|
||||
**Status:** Implemented
|
||||
**Source:** `src/Sdk/`
|
||||
**Owner:** Platform Team
|
||||
|
||||
## Purpose
|
||||
|
||||
SDK provides code generation and client libraries for integrating with StellaOps APIs. Generates strongly-typed clients from OpenAPI specifications for multiple languages (.NET, TypeScript, Python, Go).
|
||||
|
||||
## Components
|
||||
|
||||
**Tools:**
|
||||
- `StellaOps.Sdk.Generator` - OpenAPI-based client generator
|
||||
- `StellaOps.Sdk.Release` - SDK packaging and release automation
|
||||
|
||||
**Generated Clients:**
|
||||
- .NET (C#) client library
|
||||
- TypeScript/JavaScript client
|
||||
- Python client (planned)
|
||||
- Go client (planned)
|
||||
|
||||
## Configuration
|
||||
|
||||
SDK generation configured via OpenAPI specs in `docs/api/`.
|
||||
|
||||
Key features:
|
||||
- Strongly-typed API clients
|
||||
- Authentication helpers (OAuth/OIDC, DPoP)
|
||||
- Retry and error handling
|
||||
- Request/response validation
|
||||
- Offline-compatible operation
|
||||
|
||||
## Dependencies
|
||||
|
||||
- OpenAPI specifications (from all API modules)
|
||||
- Authority (authentication flows)
|
||||
- Gateway (API routing)
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- API Reference: `../../API_CLI_REFERENCE.md`
|
||||
- OpenAPI Specs: `../../api/` (if exists)
|
||||
- CLI: `../cli/`
|
||||
- Gateway: `../gateway/`
|
||||
|
||||
## Current Status
|
||||
|
||||
Generator and Release tools implemented. Supports .NET and TypeScript client generation from OpenAPI specs. Used for CLI implementation and Web frontend integration.
|
||||
10
docs-archived/modules/sdk/language-support-matrix.md
Normal file
10
docs-archived/modules/sdk/language-support-matrix.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# SDK Language Support Matrix (Wave B draft · 2025-11-26)
|
||||
|
||||
| Language | Package name (staging) | Status | Generator config | Post-processing helpers | Notes |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| TypeScript | `@stellaops/sdk` (staging) | Alpha pending OAS freeze | `src/Sdk/StellaOps.Sdk.Generator/ts/config.yaml` | Auth, retry, pagination, telemetry wired | ESM+CJS templates ready; fixture smoke test passes |
|
||||
| Python | `stellaops-sdk` (staging) | Alpha pending OAS freeze | `src/Sdk/StellaOps.Sdk.Generator/py/config.yaml` | Auth, retry, pagination, telemetry wired | Sync/async clients scaffolded; fixture smoke test passes |
|
||||
| Go | `github.com/stellaops/sdk-go` | Planned (after Python) | Generator script stub | Helpers planned | Context-first API, streaming helpers; starts after SDKGEN-63-002 |
|
||||
| Java | `io.stellaops:sdk` | Planned (after Go) | Generator script stub | Helpers planned | HTTP client abstraction TBD; starts after SDKGEN-63-003 |
|
||||
|
||||
Evidence for action tracker: Sprint 0208 · Action #2 (Publish SDK language support matrix to CLI/UI guilds).
|
||||
Reference in New Issue
Block a user