Skip to content

docs: Update docs in core and gen - #124

Merged
alpkom merged 6 commits into
mainfrom
fix/aicore-service-key-fix-docs
Sep 11, 2026
Merged

alpkom merged 6 commits into
mainfrom
fix/aicore-service-key-fix-docs

Conversation

@yamaceay

@yamaceay yamaceay commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

What this PR does and why it is needed

This PR aims to fix the inconsistencies of (1) docstring of AICoreV2Client.from_env method and (2) the authentication section of packages/gen/gen_ai_hub/docs/README.md. The changes are related to the closed SAP/ai-sdk-python-backlog#1.

Definition of Done

  • Documentation updated
    • Only Public APIs are allowed to be used in documentation/tutorials/sample code

@yamaceay
yamaceay requested a review from alpkom as a code owner September 8, 2026 09:28
@yamaceay
yamaceay force-pushed the fix/aicore-service-key-fix-docs branch 2 times, most recently from bb1b0a2 to 098033e Compare September 8, 2026 09:49
Comment thread packages/gen/docs/gen_ai_hub/README.md Outdated
Comment thread packages/gen/docs/gen_ai_hub/README.md Outdated
Comment thread packages/gen/README_sphynx.md Outdated
Comment thread packages/gen/README_sphynx.md Outdated

@alpkom alpkom left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've missed your previous PR for actually implementing this. I've just checked and it looks like you implemented the precedence of credentials different than the way it's handled in LiteLLM. Since the LiteLLM one is implemented first, and this is not documented yet, Let's first align the precedence and then document it.
The precedence should be:
kwargs → service key → env (AICORE_*) → config → VCAP service.

@yamaceay could you please adjust the implementation first and then document it accordingly?

@yamaceay
yamaceay force-pushed the fix/aicore-service-key-fix-docs branch from adfe654 to d149bb0 Compare September 9, 2026 09:20
@yamaceay
yamaceay force-pushed the fix/aicore-service-key-fix-docs branch 2 times, most recently from 5fbb8ea to 69f9927 Compare September 9, 2026 11:56
@yamaceay
yamaceay requested review from alpkom and mwien September 9, 2026 11:56

@mwien mwien left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@alpkom alpkom left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

But can you add a dummy commit with "feat(core): add support for service key" in the title?
The reason is, this change is part of core, and we'll need to create a new version of core. However, unless there is a commit with title "feat/fix(core)" the commitizen (the tool we use for version control) won't pick it up and assume no release-relevant changes were done for core.

@alpkom
alpkom merged commit dbbefad into main Sep 11, 2026
15 checks passed
@alpkom
alpkom deleted the fix/aicore-service-key-fix-docs branch September 11, 2026 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants