Standardize date range parameters for Value stream management endpoints
Background
The Value stream management pages (VSA/VSD) require data from a wide variety of api endpoints, a mixture of REST and graphql. Often this requires querying for either time series data, or aggregated data within a given time period.
The endpoints queried provide a wide variety of parameters to both in name and type to limit the query to a time period. This leads to inconsistency in requests and occasionally timezone related issues.
Page | Endpoint | Params | Format |
---|---|---|---|
VSA | /:id/-/analytics/value_stream_analytics/{summary,time_summary} |
created_before /created_after
|
YMD |
VSA | /:id/-/analytics/value_stream_analytics/value_streams/:id/stage/:id/{median,count,average_duration_chart} |
created_before /created_after
|
YMD |
Productivity Analytics | /:id/-/analytics/productivity_analytics |
merged_after /merged_before
|
ISO 8601 |
CI/CD Analytics | /api/v4/projects/:project_id/dora/metrics |
end_date /start_date
|
ISO 8601 |
Repository Analytics | /id/-/ci/daily_build_group_report_results.json |
end_date /start_date
|
YMD |
Merge Request Analytics | Graphql Query.project.mergeRequests |
mergedAfter /mergedBefore
|
YMD |
DevOps Adoption | Graphql Query.devopsAdoptionOverviewChart. |
startDate /endDate
|
YMD |
VSD | Graphql Query.flowMetrics |
from /to
|
Time ISO 8601 |
VSD | Graphql Query.dora |
startDate /endDate
|
Date, but also in ISO 8601 |
Related issues
- 422 error when fetching Value Stream Metrics in... (#412356 - closed)
- Investigate and fix flaky VSA spec in `filters_... (#360168 - closed)
- Project CI/CD Analytics charts are empty if rai... (#296451 - closed)
- Set VSA datepicker to correct UTC date (#205161 - closed)
- Broken Master: ee/spec/features/groups/analytic... (#356743 - closed)
Current proposals
-
It would be great to standardize the parameters we use going forward for new endpoints -
We should only send UTC dates formatted in YMD when querying the endpoints, regardless of if they can accept a timestamp
Edited by Ezekiel Kigbo