Skip to content

Only mention the versioned Tools API URL - #90

Merged
adriaandotcom merged 1 commit into
masterfrom
docs/only-versioned-urls
Nov 14, 2026
Merged

adriaandotcom merged 1 commit into
masterfrom
docs/only-versioned-urls

Conversation

@simpleanalytics-agent

@simpleanalytics-agent simpleanalytics-agent commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Fixes #89

 /api/tools > Versions
   We do our best to keep v1 backwards compatible: …
   That's not a guarantee, so check the list of tools when a request stops working.
-  The older URL `/api/tools` is the same as `/api/v1/tools`.

The docs now only mention https://dashboard.simpleanalytics.com/api/v1/tools and https://mcp.simpleanalytics.com/mcp/v1.

Evidence

  • Before: the built site has one mention of an unversioned URL, at the end of the Versions section of /api/tools.
    After: the built site has none. The only /api/tools left is the address of the docs page itself.
  • jekyll build passes.

Security implications

  • No security impact
  • Has security impact - described as:

Testing

Built the site with Jekyll and searched the HTML for unversioned Tools API and MCP URLs.

Merge Danger

Door: two-way

Blast Radius: copy

Summary by CodeRabbit

  • Documentation
    • Updated the Tools API documentation’s last-modified date.
    • Removed the statement that /api/tools is an alias for /api/v1/tools.

@coderabbitai

coderabbitai Bot commented Nov 14, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The Tools API page’s last-modified date changed to November 14, 2026. Its Versions section no longer states that /api/tools is the same URL as /api/v1/tools.

Changes: Tools API documentation

Layer / File(s) Summary
Update Tools API page wording
_docs/50_api/60_tools-api.md
The last-modified date changed to 2026-11-14. The Versions section no longer equates /api/tools with /api/v1/tools; its versioning and compatibility description remains.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: Minimal · up to 12238

This documentation change removes the mention of the unversioned Tools API URL so readers see only the versioned URLs. It has no runtime impact and is safe to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "Only mention the versioned Tools API URL" matches the changeset. The PR removes the statement that /api/tools equals /api/v1/tools, so the Tools API page mentions only the versioned URL. Th…
Linked Issues check Passed Issue #89 asks that the Tools API docs show only the versioned URLs https://dashboard.simpleanalytics.com/api/v1/tools and https://mcp.simpleanalytics.com/mcp/v1, and that the statement equating `…
Out of Scope Changes check Passed The PR changes one documentation file. The change removes the unversioned alias sentence, which is the work requested by #89. The last_modified_at date changes from 2026-11-13 to 2026-11-14. This is…
Full details: Title check

Explanation

The title "Only mention the versioned Tools API URL" matches the changeset. The PR removes the statement that /api/tools equals /api/v1/tools, so the Tools API page mentions only the versioned URL. The title is specific, short, and states the main change from the developer's perspective.

Full details: Linked Issues check

Explanation

Issue #89 asks that the Tools API docs show only the versioned URLs https://dashboard.simpleanalytics.com/api/v1/tools and https://mcp.simpleanalytics.com/mcp/v1, and that the statement equating /api/tools with /api/v1/tools be removed. The reviewed head of _docs/50_api/60_tools-api.md ends the Versions section without that statement. The page uses /api/v1/tools for the list and call endpoints and https://mcp.simpleanalytics.com/mcp/v1 for MCP. The remaining /api/tools string is the page's own permalink, which the issue does not require to change. The PR reports a site-wide search of built HTML that found no other unversioned Tools API or MCP URL, which matches the issue's note that this is the only mention. The repository tools available here cannot run a repository-wide search, so that claim rests on the PR's reported search and the issue text. The raw diff could not be read; the requirement was checked against the head file content instead.

Full details: Out of Scope Changes check

Explanation

The PR changes one documentation file. The change removes the unversioned alias sentence, which is the work requested by #89. The last_modified_at date changes from 2026-11-13 to 2026-11-14. This is a routine metadata update that accompanies a content edit and does not add unrelated behavior. No code, configuration, or other documentation changes appear in the PR summary. The raw diff could not be read, so the exact hunks rely on the PR summary and the head file content.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: QUIET
  • Plan: Team
  • Run ID: 9b2d17cc-7742-404a-af75-10c0079ebfb4
Commits

Reviewing files that changed from the base of the PR and between c301896 and 12238a3.

Files selected for processing: 1

  • _docs/50_api/60_tools-api.md

Included review availability: This review used your included allowance. 5 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 8 reviews per hour.

@github-actions github-actions Bot added the change: routine Routine or ordinary change that needs at most one human or AI-assisted review label Nov 14, 2026
@github-actions

Copy link
Copy Markdown

SDLC label: change: routine because The change only edits the public Tools API documentation page: it updates a last-modified date and removes a sentence saying the older /api/tools URL equals /api/v1/tools, so no application code, data, access, or infrastructure is affected.

@adriaandotcom
adriaandotcom merged commit a25857a into master Nov 14, 2026
2 checks passed
@adriaandotcom
adriaandotcom deleted the docs/only-versioned-urls branch November 14, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

change: routine Routine or ordinary change that needs at most one human or AI-assisted review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Only mention the versioned Tools API and MCP URLs

2 participants