openai / openai/openai-openapi

Publish schemas for Batch input and output/error JSONL records

Open
#578 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement specification
Dominant language
No language data
Stars
2.5k
Forks
527
Avg merge
1h 46m
Merged PRs (30d)
2

Description

Source reports

Current specification publication request

Affected surface: Batch input/output/error file records.

This is a schema-publication feature request, not a claim that Batch runtime behavior is defective. The source requests types for Batch JSONL request and result records. Neither BatchRequestInput nor BatchRequestOutput is present in the current public schema. Closed #302 addressed an obsolete patch against the removed output component; its closing explanation preserves the failing-request reproduction for a fresh request to model Batch output/error JSONL lines.

Specification reviewed at b61ced9.

Expected reconciliation

Publish complete, discoverable Batch JSONL input and result schemas with accurate body/error shapes and SDK model exposure. Reuse the #302 failing-request fixture as historical context without treating its old patch as a current fix.

Verification scope

Reviewed the source reports, relevant comments, and current published schema. No new live API request was made. This mirrors the specification gap and preserves the original reproduction; it does not claim that a fix has shipped.

Related historical report: https://github.com/openai/openai-openapi/issues/302 (closed; do not reopen its obsolete patch).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with openapi.yaml at the reviewed reference near line 30483, then inspect the historical failing-request fixture from closed issue #302. Define the Batch JSONL input and output/error schemas with accurate body and error shapes, and verify that the models are publicly discoverable through the SDK exposure described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, openapi
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.