specific time format for api documenting using flask restplus

Question

I have an api which accepts start_time, end_time and a boolean closed_all_day in body of the request.

from flask_restplus import Namespace, fields

timings = api.model('open times', {
     'start_time': fields.String(required=True, description='Time in 24 hour HH:MM format, defaulted to 00:00 if closed_all_day'),
     'end_time': fields.String(required=True, description='Time in 24 hour HH:MM format, defaulted to 00:00 if closed_all_day'),
     'closed_all_day': fields.Boolean(required=True, description='If True overwrites start_time and end_time')
})

The format of start_time and end_time would be in HH:MM (24 hour format)

if I use

fields.Date

or

fields.DateTime

then I got the full ISO date format, which is also not what I want.

Is there a way to restrict the input to HH:MM format ?

Answer 1

This is the way to do it:

from datetime import time


class TimeFormat(fields.Raw):
    def format(self, value):
        return time.strftime(value, "%H:%M")

timings = Model('timings', {
    'start_time': TimeFormat(readonly=True, description='Time in HH:MM', default='HH:MM'),
    'end_time': TimeFormat(readonly=True, description='Time in HH:MM', default='HH:MM'),
    'closed_all_day': fields.Boolean(readOnly=True, description='True or False', default=False)
})