openai / openai/openai-openapi

all webhooks are missing operation ids

Open
#485 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In OpenAPI 3.1.0 webhooks are defined as path items, as such, their operations also require an operation id.
None of the webhook operations today have an operation id.
Additionally, none of them have summary, which is also required according to the specification

Here is the list of JSON pointers:

- '#/webhooks/batch_cancelled/post/operationId'
- '#/webhooks/batch_completed/post/operationId'
- '#/webhooks/batch_expired/post/operationId'
- '#/webhooks/batch_failed/post/operationId'
- '#/webhooks/eval_run_canceled/post/operationId'
- '#/webhooks/eval_run_failed/post/operationId'
- '#/webhooks/eval_run_succeeded/post/operationId'
- '#/webhooks/fine_tuning_job_cancelled/post/operationId'
- '#/webhooks/fine_tuning_job_failed/post/operationId'
- '#/webhooks/fine_tuning_job_succeeded/post/operationId'
- '#/webhooks/realtime_call_incoming/post/operationId'
- '#/webhooks/response_cancelled/post/operationId'
- '#/webhooks/response_completed/post/operationId'
- '#/webhooks/response_failed/post/operationId'
- '#/webhooks/response_incomplete/post/operationId'

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 locating the OpenAPI 3.1 specification source and the webhook definitions named in the issue. Review the listed JSON pointers, add operationId and summary values for each webhook POST operation, then validate the specification to confirm all listed fields are present and compliant.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.