softwaremill / softwaremill/tapir
Should we prevent space inside endpoint name/operationId
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.5k
- Forks
- 468
- Avg merge
- 5h 37m
- Merged PRs (30d)
- 34
Description
Using this tool to analyze our generated open API specification, we realize that using space in operationId isn't a good practice.
The thing is that apparently, it's more of a recommendation: https://github.com/OAI/OpenAPI-Specification/issues/423 than an open API specification requirement.
Therefore, I wonder if a pull request to Tapir preventing Tapir users from putting space in name would be welcome.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how a Tapir endpoint's name becomes the OpenAPI operationId in the generated specification. Check the relevant OpenAPI generation tests and clarify whether spaces should be rejected or transformed; done means the chosen behavior is covered by tests and reflected in the generated specification.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, scala
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100