influxdata / docs-v2

InfluxData Documentation that covers InfluxDB Cloud, InfluxDB OSS 2.x, InfluxDB OSS 1.x, InfluxDB Enterprise, Telegraf, Chronograf, Kapacitor, and Flux.
https://docs.influxdata.com
MIT License
72 stars 266 forks source link

fix: use int64 for retention period in API spec #5489

Closed eatondustin1 closed 4 months ago

eatondustin1 commented 4 months ago

Closes influxdata/granite#2502.

This updates the Cloud Dedicated Management API spec to use the int64 format for the ClusterDatabaseRetentionPeriod schema, which matches the corresponding type in IOx's namespace API. The source spec was change in influxdata/granite#2503

I haven't done an API update to the docs before, but looking at how the getswagger.sh script works for the cloud-dedicated-management product case, I'm guessing an automated updated isn't really supported for the Cloud Dedicated Management API right now. I did go ahead and update the commit SHA that's referenced in the script, but the link won't work without adding a valid token query param to it since the Granite repo is private. When I did try to use that script, there were quite a few changes that looked like it was overriding manual documentation, so I just opted for manually updating the spec. Let me know if there's a different preferred approach for this.