openai / openai/openai-openapi

defect in YAML: the same member field "id" declared twice in inheritance between ComputerToolCallOutput and ComputerToolCallOutputResource

Open
#467 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

    ComputerToolCallOutput:
      type: object
      title: Computer tool call output
      description: |
        The output of a computer tool call.
      properties:
        type:
          type: string
          description: >
            The type of the computer tool call output. Always
            `computer_call_output`.
          enum:
            - computer_call_output
          default: computer_call_output
          x-stainless-const: true
        id:
          type: string
          description: |
            The ID of the computer tool call output.

......

    ComputerToolCallOutputResource:
      allOf:
        - $ref: "#/components/schemas/ComputerToolCallOutput"
        - type: object
          properties:
            id:
              type: string
              description: |
                The unique ID of the computer call tool output.
          required:
            - id

The only difference is, in derived class ComputerToolCallOutputResource, "id" becomes required.

A decent IDE or compiler will warn about such defect in OO inheritance, though the defect may be intentional.

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 ComputerToolCallOutput and ComputerToolCallOutputResource schema definitions in the YAML shown in the issue, focusing on their allOf relationship and repeated id member. Determine whether the repeated declaration is intentional, then resolve the schema inconsistency and validate that the OpenAPI specification no longer reports the duplicate inheritance field.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.