-
Bug
-
Resolution: Done
-
Normal
-
None
-
0.1.27
-
False
-
-
False
-
-
Description of the problem:
Date time is not currently compatible with all client languages. In order to keep maximum compatibility we should remove date-time format from openapi spec to prevent decoding errors from auto generated clients.
Recommendations
To make your API compatible:
- Use RFC-3339 date and date-time formats. Even if you have different internal formats, such as for interfacing with databases, do a time conversion if your API layer to publish and consume RFC-3339 date and time formats.
- If you cannot use RFC-3339, use type=string and do not use format=date or format=date-time
How reproducible:
100%
Steps to reproduce:
1. Generate python client
3. FAILED api_tests/test_orchestrator.py::test_get_workflow_run_instances - ValueError: invalid literal for int() with base 10: b'2/27'
Actual results:
FAILED api_tests/test_orchestrator.py::test_get_workflow_run_instances - ValueError: invalid literal for int() with base 10: b'2/27'
Expected results:
Pass - data is returned
Tested fix by replacing the started format date in the openapi spec:
ProcessInstanceDTO:
type: object
properties:
id:
type: string
name:
type: string
workflow:
type: string
status:
$ref: '#/components/schemas/ProcessInstanceStatusDTO'
started:
type: string
- links to