docs consolidation work
This commit is contained in:
49
docs/modules/sdk/README.md
Normal file
49
docs/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: `../../09_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.
|
||||
Reference in New Issue
Block a user