Skip to content

fix: public API continous screening schema#1702

Draft
OrriMandarin wants to merge 1 commit into
mainfrom
fix_public_api_schema
Draft

fix: public API continous screening schema#1702
OrriMandarin wants to merge 1 commit into
mainfrom
fix_public_api_schema

Conversation

@OrriMandarin

@OrriMandarin OrriMandarin commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

This pull request updates the OpenAPI schema in pubapi/openapi/v1beta.yml to correctly specify that certain query parameters accept arrays of UUID strings, improving the accuracy of the API documentation and client generation.

OpenAPI schema improvements:

  • Updated the schema for relevant query parameters to explicitly declare them as arrays of strings with UUID format in four different endpoints. This clarifies that these parameters can accept multiple values and ensures better compatibility with OpenAPI tools. [1] [2] [3] [4]

Summary by CodeRabbit

  • New Features
    • Ingestion API endpoints now support multiple monitoring configuration IDs in requests, enabling assignment of multiple configurations in a single operation across both individual and batch ingestion endpoints.

@OrriMandarin OrriMandarin self-assigned this Apr 22, 2026
@coderabbitai coderabbitai Bot added the S Small or trivial PR, review in a few minutes label Apr 22, 2026
@coderabbitai

coderabbitai Bot commented Apr 22, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@Pascal-Delange has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 52 minutes and 54 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 52 minutes and 54 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 42473eb6-b215-4ecb-ac82-e8f5823e4745

📥 Commits

Reviewing files that changed from the base of the PR and between dc67105 and 62abbc0.

📒 Files selected for processing (1)
  • pubapi/openapi/v1beta.yml
📝 Walkthrough

Walkthrough

Updated the monitoring_config_id query parameter schema in four ingestion API endpoints to accept arrays of UUID strings instead of single UUID values. Applied consistently across POST and PATCH operations for both single-object and batch ingestion routes.

Changes

Cohort / File(s) Summary
OpenAPI Schema Update
pubapi/openapi/v1beta.yml
Modified monitoring_config_id query parameter from single UUID (type: string) to array of UUIDs (type: array with items of type: string) across four endpoints: POST /ingest/{objectType}, PATCH /ingest/{objectType}, POST /ingest/{objectType}/batch, and PATCH /ingest/{objectType}/batch.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

S

Poem

Hark! A thousand monitoring configs bloom,
No more confined to singular room!
From one UUID's humble, lonesome call,
Now arrays of many grace them all.
Four endpoints dance with this change divine,
Where monitoring configs multiply and align. ✨

🚥 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 'fix: public API continous screening schema' directly addresses the main change: updating the OpenAPI schema for query parameters in ingestion endpoints.
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 fix_public_api_schema

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.

❤️ Share

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

@Pascal-Delange Pascal-Delange enabled auto-merge (rebase) April 22, 2026 19:02
@Pascal-Delange Pascal-Delange force-pushed the fix_public_api_schema branch from dc67105 to 62abbc0 Compare April 22, 2026 19:02
@Pascal-Delange Pascal-Delange disabled auto-merge April 22, 2026 19:03

@Pascal-Delange Pascal-Delange left a comment

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.

Actually, I'm not sure about this.
I know the current implementation technically allows it, but I wasn't quite sure if that's what we want to commit on, mostly because it makes for different indexing performance.
I just don't know on the top of my head TBH so let's discuss this one again after the release

@OrriMandarin OrriMandarin marked this pull request as draft April 30, 2026 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge S Small or trivial PR, review in a few minutes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants