swagger-api / swagger-api/swagger-codegen
How to add a new format definition?
Open
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
The data type, for example, string, has an optional modifier property: format. the format can be date、date-time、password, and so on.
So, how to add a new format definition for string、integer or other data types?
Contributor guide
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
The issue mentions format modifiers for string, integer, and other OpenAPI data types, but names no files, tests, or entry points. First determine where format definitions are handled in swagger-codegen, then document how a new format is added; done means the supported procedure is clear for contributors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100