Skip to content

docs(auto-monitor-setup): add upsert by external ID endpoint#169

Open
galzilber wants to merge 1 commit into
mainfrom
gz/add-pr-758-to-docs
Open

docs(auto-monitor-setup): add upsert by external ID endpoint#169
galzilber wants to merge 1 commit into
mainfrom
gz/add-pr-758-to-docs

Conversation

@galzilber
Copy link
Copy Markdown
Contributor

@galzilber galzilber commented May 18, 2026

Summary

  • Documents the new PUT /v2/auto-monitor-setups/by-external-id/{external_id} endpoint introduced in traceloop/api-service#758, covering the idempotent create/replace behavior, 200 vs 201 distinction, and env_project_id preservation.
  • Adds the page to the Auto-monitor-setups navigation group in mint.json.

Test plan

  • Preview docs site and confirm the new page renders under Auto-monitor-setups
  • Verify the curl example and request/response shapes match the implementation in PR #758

Summary by CodeRabbit

  • Documentation
    • Added API reference documentation for upserting auto-monitor setups by external ID, including request parameters, response codes, and example payloads.
    • Updated navigation to include the new API reference documentation.

Review Change Stack

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 288ef238-c851-48b7-94b9-ab4899e1e897

📥 Commits

Reviewing files that changed from the base of the PR and between 32ea768 and ba942ac.

📒 Files selected for processing (2)
  • api-reference/auto-monitor-setups/upsert-an-auto-monitor-setup-by-external-id.mdx
  • mint.json

📝 Walkthrough

Walkthrough

This PR adds comprehensive API reference documentation for a PUT endpoint that upserts auto-monitor-setups by external ID with idempotent full-replace semantics. The endpoint preserves env_project_id across updates and is newly registered in the site navigation.

Changes

Upsert Auto-Monitor Setup Endpoint Documentation

Layer / File(s) Summary
Endpoint specification and documentation
api-reference/auto-monitor-setups/upsert-an-auto-monitor-setup-by-external-id.mdx
Complete API reference for PUT /v2/auto-monitor-setups/by-external-id/{external_id} including endpoint behavior (idempotent full-replace), path parameters, request body schema with selector (required filter rules) and mutually exclusive evaluators/evaluator_configs options, curl example, 200 OK and 201 Created response codes with sample payload, and error responses for 400 Bad Request and 500 Internal Server Error.
Navigation registration
mint.json
Site navigation configuration is updated to include the new upsert endpoint documentation page alongside existing auto-monitor-setups references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A new endpoint hops into place,
Upserting with grace and full-replace,
External ID guides the way,
Docs and nav updated today! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically identifies the main change: adding documentation for the upsert endpoint functionality by external ID.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch gz/add-pr-758-to-docs

Comment @coderabbitai help to get the list of available commands and usage tips.

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 18, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
enrolla 🟢 Ready View Preview May 18, 2026, 8:08 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

---
title: "Upsert an Auto Monitor Setup by External ID"
description: "Idempotently create or fully replace an auto monitor setup identified by external ID"
api: "PUT /v2/auto-monitor-setups/by-external-id/{external_id}"
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.

update

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.

2 participants