Skip to content

deprecate: GET /role api - #1758

Open
parmesant wants to merge 1 commit into
parseablehq:mainfrom
parmesant:deprecate-role-api
Open

deprecate: GET /role api#1758
parmesant wants to merge 1 commit into
parseablehq:mainfrom
parmesant:deprecate-role-api

Conversation

@parmesant

@parmesant parmesant commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Fixes #XXXX.

Description


This PR has:

  • been tested to ensure log ingestion and log query works.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

Summary by CodeRabbit

  • Bug Fixes

    • Removed the role-list endpoint from ingestor and query web scopes.
    • Default-role and individual-role routes remain available.
  • Documentation

    • Corrected the role-list handler documentation to reference the /roles route.

@coderabbitai

coderabbitai Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 433f08c5-6176-49ea-844c-4d18461853fd

📥 Commits

Reviewing files that changed from the base of the PR and between dc189de and fe443be.

📒 Files selected for processing (3)
  • src/handlers/http/modal/ingest_server.rs
  • src/handlers/http/modal/query_server.rs
  • src/handlers/http/role.rs
💤 Files with no reviewable changes (2)
  • src/handlers/http/modal/query_server.rs
  • src/handlers/http/modal/ingest_server.rs

Included review availability: 4 reviews are currently available. Based on recent review activity, included reviews refill at 5 per hour.


Walkthrough

The change removes the GET /role listing route from the ingestor and query web scopes. Default-role and named-role routes remain. A handler comment now documents the plural /roles path.

Changes

Role route scope cleanup

Layer / File(s) Summary
Route scope and documentation updates
src/handlers/http/modal/ingest_server.rs, src/handlers/http/modal/query_server.rs, src/handlers/http/role.rs
The ingestor and query scopes no longer register GET /role. The handler comment now documents GET /api/v1/roles.

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

Merge Risk: ⚪ Minimal · up to fe443

This PR makes a small, localized change to deprecate the GET /role API, with no actionable merge-blocking risk remaining beyond normal checks and review.

Poem

A rabbit checks the routes with care,
No role list hops from here to there.
Default and named paths stay bright,
The plural sign now reads just right.
Thump, thump—clean scopes take flight!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description contains only the repository template and provides no goal, rationale, key changes, issue reference, or test status. Add the PR goal, chosen solution and rationale, key changes, applicable issue reference, and completed test and documentation checklist items.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: deprecation of the GET /role API.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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.

1 participant