Skip to content

Conversation

@buger
Copy link
Member

@buger buger commented Dec 8, 2025

🔗 Auto-generated mirror PR for Mintlify preview

Original PR: #1154
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.

⚠️ Important Notes

Changes

Summary

  • Adds new documentation page explaining how to configure uptime tests to dynamically discover endpoints using service discovery
  • Addresses the documentation gap identified in DX-2022
  • Incorporates findings from TT-14943 regarding the correct JSON structure for query endpoints

What's Included

The new documentation page () covers:

  • Introduction: Use cases and how the feature works
  • Prerequisites: Required setup before configuring
  • Query Endpoint JSON Structure: Examples for simple, nested, and target list formats
  • API Definition Configuration: Complete reference table with all options
  • Service Discovery Examples:
    • Consul (with health endpoint)
    • etcd (simple and nested JSON)
    • Eureka (with JSON response)
  • Dashboard Configuration: Step-by-step UI instructions
  • Combining Static and Dynamic Tests: How to mix manual and discovered endpoints
  • Integration with Load Balancing: Using
  • Troubleshooting Guide: Common issues and solutions

Navigation Changes

Added the new page to under:

  • API Management → Deploy Tyk → Tyk Self Managed → Configuration

The page appears after Uptime
Tests for logical navigation flow.

Test Plan

  • Verify the new page renders correctly in the documentation site
  • Check all internal links work correctly
  • Confirm JSON examples are syntactically valid
  • Review navigation placement in the sidebar

Related Issues

  • Resolves: DX-2022 (Documentation on Configuring Service Discovery for Uptime Tests)
  • Related: TT-14943 (Identify correct JSON returned by the Query Endpoint)

🤖 Generated with Claude Code

yurisasuke and others added 30 commits June 19, 2025 18:50
* 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>
Revert "Add auto merge (#179)"

This reverts commit 032eac1.
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
sharadregoti and others added 17 commits November 24, 2025 10:43
… tests

Add new documentation page explaining how to configure uptime tests to
dynamically discover endpoints using service discovery. This addresses
the gap identified in DX-2022 and incorporates findings from TT-14943
regarding the correct JSON structure for query endpoints.

The documentation includes:
- Prerequisites and introduction to the feature
- Query endpoint JSON structure examples (simple, nested, target list)
- Complete API definition configuration reference
- Service discovery examples for Consul, etcd, and Eureka
- Dashboard configuration steps
- Instructions for combining static and dynamic tests
- Integration with load balancing
- Troubleshooting guide

Resolves: DX-2022
Related: TT-14943

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
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.

7 participants