search

ts-spec / tspec

Type-driven API Documentation library. Auto-generating REST API document based on TypeScript types.
https://ts-spec.github.io/tspec/
MIT License
108 stars 5 forks source link

Allow for custom `operationId` naming. #41

Closed ConnysCode closed 8 months ago

ConnysCode commented 8 months ago

First of all, tspec is an amazing piece of work! That being said, I believe there's room for improvement. Currently, it appears that tspec does not offer the capability to assign custom values to a request's operationId.

I propose enhancing tspec to support custom operationId assignment for requests.

ConnysCode commented 8 months ago

Additionally - dependent on the context and intended use of the generated spec - it might even be useful to completely remove said property.

ConnysCode commented 8 months ago

I've taken the liberty to create a little draft here: https://github.com/ts-spec/tspec/pull/42

I could not find any contribution guidelines. So don't hesitate to hit me up if you need me to change something.

hyeonss0417 commented 8 months ago

Thanks for the great suggestion and contribution!

We'll have that PR (#42) reviewed and launched as soon as possible 🙂 .