openai / openai/openai-openapi

Non-existent properties are defined as required

Open Beginner friendly
#532 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hey there,

As of today there are a few places in the schema components that specify property names as required but those properties are not actually specified in their corresponding sets of properties.

  • For example: LocalShellToolCallOutput -> call_id here is not specified in properties:
LocalShellToolCallOutput:
  type: object
  title: Local shell call output
  description: |
    The output of a local shell tool call.
  properties:
    type:
      type: string
      ...
    id:
      type: string
      ...
    output:
      type: string
      ...
    status:
      anyOf:
        - type: string
          ...
        - type: 'null'
  required:
    - id
    - type
    - call_id
    - output
  • Another example: MCPApprovalResponse -> request_id (marked as required) is not one of the available properties.
MCPApprovalResponse:
  type: object
  title: MCP approval response
  description: |
    A response to an MCP approval request.
  properties:
    type:
      type: string
      ...
    id:
      anyOf:
        - type: string
          ...
        - type: 'null'
    approval_request_id:
      type: string
      ...
    approve:
      type: boolean
      ...
    reason:
      anyOf:
        - type: string
         ...
        - type: 'null'
  required:
    - type
    - request_id
    - approve
    - approval_request_id

Further examples:

  • MCPApprovalResponseResource -> request_id
  • ResponseAudioDoneEvent -> response_id
  • ResponseAudioTranscriptDeltaEvent -> response_id
  • ResponseAudioTranscriptDoneEvent -> response_id
  • UsageCodeInterpreterSessionsResult -> sessions

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 the OpenAPI schema components named in the issue, including LocalShellToolCallOutput and MCPApprovalResponse, and compare each required list with its properties map. Check all listed examples and confirm that every required name has a corresponding property; the schema should validate without these mismatches.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.