Skip to content

fix(ai-gateway): Align providers docs with 0.0.47 API schema#5875

Merged
tomek-labuk merged 25 commits into
release/ai-gateway-2.0from
update-providers-docs
Jul 10, 2026
Merged

fix(ai-gateway): Align providers docs with 0.0.47 API schema#5875
tomek-labuk merged 25 commits into
release/ai-gateway-2.0from
update-providers-docs

Conversation

@tomek-labuk

@tomek-labuk tomek-labuk commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Description

This PR updates AI Provider entity docs, and aligns them with the latest API schema. Recap of changes:

AI Model Provider

  • Renamed the old entity from AI Provider to AI Model Provider
  • Added paragraph distinguishing outbound credentials (AI Model Provider authenticates to the upstream LLM) from inbound authentication (AI Identity Provider validates the AI Consumer calling the model)
  • Added AI Identity Provider to related_resources

AI Identity Provider (new file)

  • Created aew entity reference page covering key-auth and openid-connect provider types
  • Documented per-model assignment via access.identity_providers, one provider per type per model maximum
  • Covered anonymous consumer fallback behavior (unauthenticated requests terminate with 401)
  • Added a note that all models in the same gateway sharing OIDC auth must reference the same openid-connect identity provider
  • client_secret on the OIDC type is referenceable from an AI Vault
  • Fixed access.acls code example to use correct allow/deny object shape per v0.0.47 spec

Context here

Note:
This affects all other AI Gateway 2.0 documentation, I will be opening up PRs against this branch with various updates.

Preview Links

https://deploy-preview-5875--kongdeveloper.netlify.app/ai-gateway/entities/ai-model-provider
https://deploy-preview-5875--kongdeveloper.netlify.app/ai-gateway/entities/ai-identity-provider

Checklist

  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable).

@netlify

netlify Bot commented Jul 8, 2026

Copy link
Copy Markdown

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 788d820
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/6a50b08c8a4bb400083f8ad5
😎 Deploy Preview https://deploy-preview-5875--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@tomek-labuk tomek-labuk force-pushed the update-providers-docs branch from 6397bac to 13f6ed8 Compare July 8, 2026 12:40
@tomek-labuk tomek-labuk marked this pull request as ready for review July 8, 2026 13:38
@tomek-labuk tomek-labuk requested a review from a team as a code owner July 8, 2026 13:38
Copilot AI review requested due to automatic review settings July 8, 2026 13:38

Copilot AI 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.

Pull request overview

Updates AI Gateway entity reference docs to reflect the v0.0.47 Konnect AI Gateway API schema, including renaming the “AI Provider” entity concept to “AI Model Provider” and adding a new “AI Identity Provider” entity page for inbound authentication.

Changes:

  • Updated the AI Provider entity reference page to “AI Model Provider”, including schema path + API endpoint changes and new outbound-vs-inbound auth explanation.
  • Added a new AI Identity Provider entity reference page documenting key-auth and openid-connect identity provider types and AI Model assignment.
  • Extended entity_examples config to support model-provider and identity-provider endpoints and expose identity providers in the UI format list.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

File Description
app/_data/entity_examples/config.yml Adds AI Gateway endpoint mappings for new entity-example types and updates UI-supported AI Gateway entities.
app/_ai_gateway_entities/ai-provider.md Renames the entity doc to AI Model Provider, updates schema/API paths, and expands explanation of provider roles.
app/_ai_gateway_entities/ai-identity-provider.md Introduces a new entity reference page for inbound authentication providers (key-auth and OIDC).

Comment thread app/_ai_gateway_entities/ai-provider.md
Comment thread app/_ai_gateway_entities/ai-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-provider.md
Comment thread app/_ai_gateway_entities/ai-identity-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-identity-provider.md
Comment thread app/_data/entity_examples/config.yml Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ tomek-labuk
❌ Copilot
You have signed the CLA already but the status is still pending? Let us recheck it.

@tomek-labuk tomek-labuk added the do not merge Issues/ PRs whose changes should not be merged at this time label Jul 8, 2026

@cloudjumpercat cloudjumpercat 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.

Mostly nitpicks for everything! Just had one section about AI Model Provider authentication that I think could use more specific language.

Comment thread app/_ai_gateway_entities/ai-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-identity-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-identity-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-identity-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-identity-provider.md Outdated
Comment thread app/_ai_gateway_entities/ai-identity-provider.md Outdated
tomek-labuk and others added 8 commits July 10, 2026 09:26
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
tomek-labuk and others added 9 commits July 10, 2026 09:49
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@tomek-labuk tomek-labuk merged commit 8da4269 into release/ai-gateway-2.0 Jul 10, 2026
17 checks passed
@tomek-labuk tomek-labuk deleted the update-providers-docs branch July 10, 2026 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do not merge Issues/ PRs whose changes should not be merged at this time

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants