github / rest-api-description

An OpenAPI description for GitHub's REST API
MIT License
1.38k stars 225 forks source link

[Schema Bug] Multiple different endpoints are using the same value for `operationID` GHES 3.12, GHES 3.13 #3720

Open wolfy1339 opened 3 months ago

wolfy1339 commented 3 months ago

Schema Inaccuracy

Multiple different endpoints are using the same value for operationID of enterprise-admin/get-manage-settings

Expected

Each endpoint has it's own uniuqe operationID The the OpenAPI specs be free of bugs like this one that prevents it's usage

Reproduction Steps

N/A as it concerns the schema definitions and not actual response data

Suggested solution

I would like to suggest that the OpenAPI specs be passed through a linter of the likes of Redocly before publishing to minimize any bugs like this

See https://github.com/octokit/openapi-types.ts/pull/429#issuecomment-2209656935

shiftkey commented 3 months ago

@wolfy1339 thanks for the heads up - I've reached out to the team who created these operations, shouldn't be too hard to fix.

Just091 commented 1 month ago

Bcp14

Just091 commented 1 month ago

BCP14