added new models and updated x-project-id to optional - #15
Merged
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR adds two model API references, updates OpenAPI authentication and Batch schemas, migrates enriched IAB classifier references to v2, and refreshes catalogs, pricing tables, examples, and integration guidance. ChangesBatch API contract
New model references
Authentication and model migration
Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (4)
api-reference/openapi/playgrounds/gpt-oss-120b.openapi.json (2)
380-402: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueUnused
InputMessageschema.Not referenced anywhere in this spec —
CreateResponseRequest.inputis a plain string, not this object shape. Looks like a leftover from a template whereinputsupported structured messages.🧹 Proposed cleanup
- "InputMessage": { - "type": "object", - "required": [ - "role", - "content" - ], - "properties": { - "role": { - "type": "string", - "enum": [ - "user", - "system" - ] - }, - "content": { - "type": "string", - "minLength": 1, - "format": "textarea", - "maxLength": 131072, - "description": "Message text." - } - } - }, "Response": {🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@api-reference/openapi/playgrounds/gpt-oss-120b.openapi.json` around lines 380 - 402, Remove the unused InputMessage schema from the OpenAPI components, since CreateResponseRequest.input remains a plain string and does not reference this object shape. Do not alter the existing request schema or other component definitions.
333-338: 🚀 Performance & Scalability | 🔵 Trivial | ⚡ Quick winBound the
messagesarray size. Both new playground specs defineCreateChatCompletionRequest.messageswithminItems: 1but no upper bound, flagged by Checkov (CKV_OPENAPI_21).
api-reference/openapi/playgrounds/gpt-oss-120b.openapi.json#L333-L338: add amaxItemscap to themessagesarray inCreateChatCompletionRequest.api-reference/openapi/playgrounds/qwen3-30b-a3b-fp8.openapi.json#L171-L176: same fix for themessagesarray in itsCreateChatCompletionRequest.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@api-reference/openapi/playgrounds/gpt-oss-120b.openapi.json` around lines 333 - 338, Add a finite maxItems cap to the messages array in CreateChatCompletionRequest in both api-reference/openapi/playgrounds/gpt-oss-120b.openapi.json:333-338 and api-reference/openapi/playgrounds/qwen3-30b-a3b-fp8.openapi.json:171-176, preserving the existing minItems and ChatMessage reference.Source: Linters/SAST tools
api-reference/openapi/batch.openapi.json (2)
617-644: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueConsider bounding
dataarray sizes.Checkov (CKV_OPENAPI_21) flags
FileList.dataandBatchList.datafor missingmaxItems. Adding a bound (or documentinglimit's max as the effective bound) improves schema completeness for consumers/tooling.Also applies to: 766-792
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@api-reference/openapi/batch.openapi.json` around lines 617 - 644, Update the FileList.data and BatchList.data array schemas to declare a maximum item count using the API’s established limit maximum as the bound, ensuring both schemas satisfy CKV_OPENAPI_21 without changing their item references or response structure.Source: Linters/SAST tools
101-111: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winDuplicated
x-project-idheader parameter across 9 operations.The same parameter object (name/schema/description) is repeated verbatim 9 times in this file. Extracting it to
components.parameters.ProjectIdand referencing via$refwould reduce duplication and centralize future wording changes.♻️ Proposed refactor
+ "components": { + "parameters": { + "ProjectId": { + "name": "x-project-id", + "in": "header", + "required": false, + "schema": { "type": "string" }, + "description": "Optional project identifier. Scopes the request to a specific project when provided." + } + }, ... - "parameters": [ - { - "name": "x-project-id", - ... - } - ] + "parameters": [ + { "$ref": "`#/components/parameters/ProjectId`" } + ]Also applies to: 120-129, 208-216, 251-259, 296-304, 395-403, 413-421, 473-481, 518-526
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@api-reference/openapi/batch.openapi.json` around lines 101 - 111, Extract the repeated x-project-id header parameter into components.parameters.ProjectId, preserving its name, header location, optionality, string schema, and description. Replace all nine inline parameter objects in the affected operations with $ref references to the centralized ProjectId component.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@api-reference/openapi/batch.openapi.json`:
- Around line 178-196: Restore the previously documented error responses for the
GET /v1/files and GET /v1/batches list operations: add 500 to both, and add 400
(Invalid limit) to GET /v1/batches. Keep the existing 401, 403, and 429
responses unchanged and align both operations with their corresponding POST
definitions.
In `@cookbook/batch-review-tagging.mdx`:
- Line 63: Update the setup section and its getpass prompt to treat the Project
ID as optional, consistent with the request description near the cURL examples.
Keep the API key required, and make project-scoped input conditional rather than
always prompting for x-project-id.
In `@docs/batch/errors.mdx`:
- Around line 74-75: The Fix line in the documented error entry contradicts the
updated Cause and incorrectly requires both headers. Update the Fix text to
instruct sending the required x-api-key header on every request, while treating
x-project-id as optional.
---
Nitpick comments:
In `@api-reference/openapi/batch.openapi.json`:
- Around line 617-644: Update the FileList.data and BatchList.data array schemas
to declare a maximum item count using the API’s established limit maximum as the
bound, ensuring both schemas satisfy CKV_OPENAPI_21 without changing their item
references or response structure.
- Around line 101-111: Extract the repeated x-project-id header parameter into
components.parameters.ProjectId, preserving its name, header location,
optionality, string schema, and description. Replace all nine inline parameter
objects in the affected operations with $ref references to the centralized
ProjectId component.
In `@api-reference/openapi/playgrounds/gpt-oss-120b.openapi.json`:
- Around line 380-402: Remove the unused InputMessage schema from the OpenAPI
components, since CreateResponseRequest.input remains a plain string and does
not reference this object shape. Do not alter the existing request schema or
other component definitions.
- Around line 333-338: Add a finite maxItems cap to the messages array in
CreateChatCompletionRequest in both
api-reference/openapi/playgrounds/gpt-oss-120b.openapi.json:333-338 and
api-reference/openapi/playgrounds/qwen3-30b-a3b-fp8.openapi.json:171-176,
preserving the existing minItems and ChatMessage reference.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: cd52529c-f099-4a35-a06b-66abeb0a6be2
📒 Files selected for processing (35)
api-reference/models/gpt-oss-120b.mdxapi-reference/models/qwen3-30b-a3b-fp8.mdxapi-reference/models/zlm-v1-iab-classify-edge.mdxapi-reference/models/zlm-v2-iab-classify-edge-enriched.mdxapi-reference/openapi/batch.openapi.jsonapi-reference/openapi/playgrounds/LFM2_5-1_2B-Instruct.openapi.jsonapi-reference/openapi/playgrounds/LFM2_5-1_2B-Thinking.openapi.jsonapi-reference/openapi/playgrounds/deberta-v3-small.openapi.jsonapi-reference/openapi/playgrounds/gliner-multi-pii-v1.openapi.jsonapi-reference/openapi/playgrounds/gliner2-base-v1.openapi.jsonapi-reference/openapi/playgrounds/gpt-oss-120b.openapi.jsonapi-reference/openapi/playgrounds/llama-3_1-8b-instruct-fast.openapi.jsonapi-reference/openapi/playgrounds/qwen3-30b-a3b-fp8.openapi.jsonapi-reference/openapi/playgrounds/zlm-v1-followup-questions-edge.openapi.jsonapi-reference/openapi/playgrounds/zlm-v1-iab-classify-edge.openapi.jsonapi-reference/openapi/playgrounds/zlm-v1-iab-domain-classifier.openapi.jsonapi-reference/openapi/playgrounds/zlm-v2-iab-classify-edge-enriched.openapi.jsonapi-reference/openapi/zerogpu.openapi.jsoncookbook/batch-review-tagging.mdxcookbook/claude-iab-targeted-copy.mdxdocs.jsondocs/ad-tech.mdxdocs/batch/errors.mdxdocs/batch/index.mdxdocs/model-catalog.mdxdocs/pii.mdxdocs/platform.mdxdocs/quickstart.mdxdocs/summarization.mdxdocs/text-classification.mdxdocs/text-generation.mdxintegrations/claude-code-plugin.mdxintegrations/langchain.mdxintegrations/mcp.mdxintegrations/openclaw.mdx
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
gpt-oss-120bandqwen3-30b-a3b-fp8.x-project-idoptional (withx-api-keyrequired) across REST docs, playgrounds, and examples/integrations.File/Batch/pagination details; updated model allowlists and related examples.zlm-v2-iab-classify-edge-enrichedwhere applicable.