Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for handling custom date formats #5

Open
bbqsrc opened this issue May 16, 2018 · 0 comments
Open

Add support for handling custom date formats #5

bbqsrc opened this issue May 16, 2018 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@bbqsrc
Copy link
Contributor

bbqsrc commented May 16, 2018

Custom date formats are a super common "feature" of the real world, and mapping APIs to the real world, particularly with custom date formats is a pain point with OpenAPI.

There's a few ways we can go about implementing this, but having a coherent story that is easily implemented in each platform would be great.

A couple of ideas have been proposed:

  • Using a custom format with formatting string as a parameter, like custom-date(mm-yyyy-DD), though this introduces parsing complexity
  • Using a custom field along side a well known custom format, such as:
type: string
format: custom-date
x-date-format: mm-yyyy-DD

Both have their pros and cons.

@bbqsrc bbqsrc added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels May 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant