[Schema Inaccuracy] Consider making Workflow ID int64 to future-proof against overflow
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 38/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api, documentation
Research direction
Locate the OpenAPI components at #/components/parameters/workflow-id and #/components/schemas/workflow/id. Check how their integer types are currently represented and update the schema metadata so both support the requested future ID range. Done means both documented Workflow ID locations consistently represent the wider type and the schema remains valid.
Written by the indexing model from the issue text.
Description
Consider changing the Workflow ID parameter and model to use int64 instead of int. A recent Workflow I created got the ID of around 141,000,000 which is still a ways from int.MaxValue of 2,147,483,647. But given enough time and more users making workflows this could eventually overflow.
Schema Inaccuracy
#/components/parameters/workflow-id- Consider that int32 may overflow in the future. Add format: int64#/components/schemas/workflow/id- Consider that int32 may overflow in the future. Add format: int64
Expected
No overflow
Reproduction Steps
No current overflow, so no reproduction. However
- Dominant language
- No language data
- Stars
- 1.6k
- Forks
- 342
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 57
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.
More from github/rest-api-description
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
github/rest-api-description#7220 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
github/rest-api-description#7201 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/rest-api-description#7163 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7162 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7135 ·
All issues in github/rest-api-description
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
canonical/paas-charm#368 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
area:workflow bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fil-donadoni/tolaria#4409 ·
-
status/awaiting_triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100