influxdata / influxdata/openapi
Wrong type for IDs included in `TemplateSummary` responses
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 18
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
The spec for `TemplateSummary` objects says it includes IDs typed as `string` (for example, [here](https://github.com/influxdata/openapi/blob/master/src/common/schemas/TemplateSummary.yml#L17-L20)). In practice both OSS and Cloud return `int64` values for those IDs, because of a bug in the JSON marshalling shared across both. Ideally we'd fix the impls to match the spec, but the int format has been in the wild long enough that we should be wary of the breaking change. A more practical choice would be to update the spec to use `type: integer` and `format: int64` for now, and roll out string IDs later under a different key.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start with src/common/schemas/TemplateSummary.yml, especially lines 17–20, and inspect the ID property definitions against the response behavior described in the issue. Update the specification so the affected IDs use the observed integer format, then validate that the TemplateSummary schema reflects the intended API contract.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100