stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 2 Releases Wiki Activity
Files
4f6dd4de8369908cb4e16ba58b06ddb25930504c
git.stella-ops.org/docs/modules/sdk
History
StellaOps Bot 0103defcff docs consolidation work
2025-12-25 19:09:48 +02:00
..
language-support-matrix.md
up
2025-11-26 20:23:28 +02:00
README.md
docs consolidation work
2025-12-25 19:09:48 +02:00

README.md

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.