openai / openai/openai-openapi

Duplicate top_logprobs properties across type hierarchies

Open
#525 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

The CreateChatCompletionRequest component schema is defined as an allOf CreateModelResponseProperties + a set of properties.

Both schemas contain an equivalent definition of the top_logprobs property. Not only this is redundant, but this can throw some generation tooling (docs, SDKs...) off the rails.
This is of course just one example, the description contains multiple instances like those.

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 inspecting the CreateChatCompletionRequest schema and its CreateModelResponseProperties allOf component, then search the specification for other equivalent properties duplicated across type hierarchies. Done means redundant definitions are consolidated without changing the API schema semantics and generation tooling no longer encounters those duplicates.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.