🔄 Preview: docs: add event metadata documentation for all Gateway Events#1157
Closed
buger wants to merge 213 commits intoproductionfrom
Closed
🔄 Preview: docs: add event metadata documentation for all Gateway Events#1157buger wants to merge 213 commits intoproductionfrom
buger wants to merge 213 commits intoproductionfrom
Conversation
push initial code
fix get started broken link
* add release-bot * add release-bot --------- Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
* Update outbound-email-configuration.mdx fix something * Create bla.mdx * Update docs.json
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
* add mirror pr as draft * auto merge pull request --------- Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
This commit adds comprehensive metadata documentation for all Gateway Events in the gateway-events.mdx file. For each event type, an expandable section now describes the metadata fields that are passed to event handlers (webhooks, custom handlers). Events documented: - Rate limit events: RatelimitExceeded, OrgRateLimitExceeded, RateLimitSmoothingUp, RateLimitSmoothingDown - Quota events: QuotaExceeded, OrgQuotaExceeded - Authentication events: AuthFailure, KeyExpired, UpstreamOAuthError - Version events: VersionFailure - Circuit breaker events: BreakerTripped, BreakerReset, BreakerTriggered - Uptime events: HostDown, HostUp - Token lifecycle events: TokenCreated, TokenUpdated, TokenDeleted - Certificate events: CertificateExpiringSoon, CertificateExpired - Quota monitoring: TriggerExceeded Resolves: DX-2108 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔗 Auto-generated mirror PR for Mintlify preview
Original PR: #1156
Author: @buger
Purpose
This PR provides a Mintlify preview link for reviewing documentation changes.
Preview Link
The Mintlify preview will be available once this PR is processed.
Changes
Summary
Events Documented
Rate limit events
Quota events
Authentication failure events
Version events
Circuit breaker events
Uptime events
Token lifecycle events
Certificate expiry events
Quota monitoring
Source of Truth
The metadata fields were extracted from the Go struct definitions in the Tyk Gateway repository:
Test plan
Resolves: DX-2108
🤖 Generated with Claude Code