openai / openai/openai-openapi

Multipart request bodies are missing encoding information

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

Nobody has claimed this yet.

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

Description

Throughout the API surface, there are multiple operations that accept a multiple request body.
The description is missing encoding information for the parts, see the example overlay action below.
This lack of information hinders code generation ability to enable proper representation of the payload, and serialization abilities.

- update:
      encoding:
        file:
          contentType: application/octet-stream
        model:
          contentType: text/plain
        chunking_strategy:
          contentType: text/plain
        include:
          contentType: application/json
        language:
          contentType: text/plain
        prompt:
          contentType: text/plain
        response_format:
          contentType: text/plain
        stream:
          contentType: application/json
        temperature:
          contentType: application/json
        timestamp_granularities:
          contentType: application/json
    description: Adds missing parameters for the path item
    target: >-
      $.paths['/audio/transcriptions'].post.requestBody.content['multipart/form-data']

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 by reviewing the OpenAPI request-body definitions for multipart operations and compare them with the example target at /audio/transcriptions POST. Identify each part that lacks encoding information, then update the affected descriptions so their content types are represented consistently. Done means the multipart request bodies expose encoding metadata needed for payload representation and serialization.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.