Skip to content

docs(adr): Add code generator for context registry ADR #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mwien wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs(adr): Add code generator for context registry ADR #211

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79e2723
docs(adr): add draft of code generator for context registry ADR
mwien Oct 30, 2026
eeb22e8
small fix
mwien Oct 30, 2026
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
45 changes: 45 additions & 0 deletions adr/0006-openapi-generator-context-registry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# OpenAPI Generator for Context Registry

## Status

Under discussion

## Context

The [context registry service](https://github.tools.sap/AI/context-registry) is currently not supported in the Python SDK. The Java and JS SDKs heavily rely on code generation and will generate the new client for context registry from [the spec](https://github.tools.sap/AI/context-registry/tree/main/src/spec). The Python SDK, on the other hand, is currently fully manually written. Code generation has been explored as a future option, see [ADR 0004](https://github.com/SAP/ai-sdk-python/blob/main/adr/0004-openapi-generators.md) and [this PoC](https://github.com/SAP/ai-sdk-python/pull/99) introducing the OpenAPI generator including a working client for the context registry service. This ADR decides how the context registry client will be added to the Python SDK: with code generation or as a manually written client.

## Decision

TBD

## Consequences

TBD

## Appendix

### Option A (Manually-written Client)

Pros:

- Fully aligned with the current general approach and coding style in the SDK
- For the context registry spec on its own, adding the client manually would be faster than first introducing a code generator

Cons:

- Higher maintenance effort
- More difficult to keep up-to-date with spec changes (no automation)

### Option B (Generated Client)

Pros:

- Lower maintenance effort, in particular if code generation is used for multiple services (not only context registry)
- Easy to regenerate client code in case of spec changes
- Consistent with the approach in the Java and JS SDK

Cons:

- Need to maintain code generator including customizations (however, Java and JS SDKs report this cost being lower than keeping the clients up-to-date manually)
- Initially adding the generator takes time and effort
- The generated client will stylistically not be fully consistent with the manually written clients in the SDK (for example with regard to how the `ai_resource_group` header is handled)
Loading