-
-
Notifications
You must be signed in to change notification settings - Fork 0
feat:Update OpenAPI operationId for /v1/serp/{path} GET and POST #632
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughUpdated OpenAPI operationId values in src/libs/Jina/openapi.yaml for /v1/serp/{path}: both GET and POST now use serp_v1_serp__path__get. No changes to paths, parameters, or response schemas. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
src/libs/Jina/Generated/Jina.Models.SerpV1SerpPathGetResponse.Json.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.SerpV1SerpPathGetResponse.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.SerpV1SerpPathGetResponse2.Json.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.SerpV1SerpPathGetResponse2.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Jina/openapi.yaml(2 hunks)
| - serp | ||
| summary: Serp | ||
| operationId: serp_v1_serp__path__post | ||
| operationId: serp_v1_serp__path__get |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Duplicate operationId violates OpenAPI uniqueness; keep GET as-is.
This operationId is fine for GET. The problem is POST below reuses the same id.
Run to confirm duplicates:
🏁 Script executed:
#!/bin/bash
rg -nC1 -g '!**/node_modules/**' -g '!**/dist/**' -P $'^\\s*operationId:\\s*serp_v1_serp__path__get\\b'Length of output: 148
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Repo root: $(pwd)"
echo
echo "Searching for exact operationId occurrences..."
rg -n --hidden -S --no-ignore "operationId:\s*serp_v1_serp__path__get" || true
echo
echo "Searching for token serp_v1_serp__path__get anywhere..."
rg -n --hidden -S --no-ignore "serp_v1_serp__path__get" || true
echo
echo "Searching for 'operationId:' lines under src (context +-1)..."
rg -n --hidden -S "operationId:" --glob 'src/**' --glob '!node_modules/**' --glob '!dist/**' -C1 || true
echo
if [ -f "src/libs/Jina/openapi.yaml" ]; then
echo "Printing lines 280-320 of src/libs/Jina/openapi.yaml (around reported line 306):"
nl -ba src/libs/Jina/openapi.yaml | sed -n '280,320p'
else
echo "File src/libs/Jina/openapi.yaml not found."
fiLength of output: 3747
Duplicate operationId violates OpenAPI uniqueness; keep GET as-is.
serp_v1_serp__path__get is defined twice in src/libs/Jina/openapi.yaml (lines 306 and 330). Keep the GET occurrence (line 306) and rename the other operationId to a unique name (e.g. serp_v1_serp__path__post); update any references.
🤖 Prompt for AI Agents
In src/libs/Jina/openapi.yaml around lines 306 and 330, there is a duplicate
operationId (serp_v1_serp__path__get) which violates OpenAPI uniqueness; keep
the GET occurrence at line 306 as-is and change the operationId at line 330 to a
unique name (for example serp_v1_serp__path__post), then update any code or
generated client references that rely on that operationId to the new name and
validate the OpenAPI file to ensure no remaining duplicates.
| - serp | ||
| summary: Serp | ||
| operationId: serp_v1_serp__path__post | ||
| operationId: serp_v1_serp__path__get |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix duplicate operationId on POST (must be unique).
OpenAPI requires operationId to be unique across all operations; reusing the GET id will break codegen. Rename POST’s id to the method-specific variant to match your existing convention.
Apply this diff:
summary: Serp
- operationId: serp_v1_serp__path__get
+ operationId: serp_v1_serp__path__post📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| operationId: serp_v1_serp__path__get | |
| operationId: serp_v1_serp__path__post |
🤖 Prompt for AI Agents
In src/libs/Jina/openapi.yaml around line 330, the POST operation reuses the GET
operationId 'serp_v1_serp__path__get', which must be unique; change the POST
operationId to a method-specific unique name following the existing convention
(for example 'serp_v1_serp__path__post' or similar), update any references if
present, and ensure no other operationIds collide.
Summary by CodeRabbit
Bug Fixes
Documentation