openai / openai/openai-openapi

response schema missing for `operationId: deleteResponse`

Open Beginner friendly
#490 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Noticed the python sdk returns None when using responses.delete which I suspect is because of the missing schema for operationId: deleteResponse in

https://github.com/openai/openai-openapi/blob/manual_spec/openapi.yaml#L11870-L11892

python sdk NoneType cast:
https://github.com/openai/openai-python/blob/main/src/openai/resources/responses/responses.py#L1441

This could cause issues since the actual API endpoints currently return a proper response object like

{
  "id": "resp_0b6dcxxx",
  "object": "response.deleted",
  "deleted": true
}

Would be nice to have that be propagated in client sdks too.

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 in openapi.yaml around lines 11870-11892 and inspect the schema for operationId deleteResponse. Compare it with the response example in the issue and trace the generated handling in openai-python at src/openai/resources/responses/responses.py:1441. Done when the specification represents the deleted response object so client SDKs no longer cast responses.delete to None.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.