apidocs: fix compatibility with OpenAPI 3.0 (#5210)

double-precision numbers are now represented as double.
This commit is contained in:
Omar Ferro 2025-11-22 23:05:08 +01:00 committed by GitHub
parent 697211332a
commit e168d2f3f4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 20 deletions

View file

@ -432,16 +432,16 @@ components:
type: boolean type: boolean
rpiCameraBrightness: rpiCameraBrightness:
type: number type: number
format: float64 format: double
rpiCameraContrast: rpiCameraContrast:
type: number type: number
format: float64 format: double
rpiCameraSaturation: rpiCameraSaturation:
type: number type: number
format: float64 format: double
rpiCameraSharpness: rpiCameraSharpness:
type: number type: number
format: float64 format: double
rpiCameraExposure: rpiCameraExposure:
type: string type: string
rpiCameraAWB: rpiCameraAWB:
@ -452,7 +452,7 @@ components:
maxItems: 2 maxItems: 2
items: items:
type: number type: number
format: float64 format: double
rpiCameraDenoise: rpiCameraDenoise:
type: string type: string
rpiCameraShutter: rpiCameraShutter:
@ -462,10 +462,10 @@ components:
type: string type: string
rpiCameraGain: rpiCameraGain:
type: number type: number
format: float64 format: double
rpiCameraEV: rpiCameraEV:
type: number type: number
format: float64 format: double
rpiCameraROI: rpiCameraROI:
type: string type: string
rpiCameraHDR: rpiCameraHDR:
@ -476,7 +476,7 @@ components:
type: string type: string
rpiCameraFPS: rpiCameraFPS:
type: number type: number
format: float64 format: double
rpiCameraAfMode: rpiCameraAfMode:
type: string type: string
rpiCameraAfRange: rpiCameraAfRange:
@ -485,7 +485,7 @@ components:
type: string type: string
rpiCameraLensPosition: rpiCameraLensPosition:
type: number type: number
format: float64 format: double
rpiCameraAfWindow: rpiCameraAfWindow:
type: string type: string
rpiCameraFlickerPeriod: rpiCameraFlickerPeriod:
@ -814,7 +814,7 @@ components:
format: int64 format: int64
rtpPacketsJitter: rtpPacketsJitter:
type: number type: number
format: float64 format: double
rtcpPacketsReceived: rtcpPacketsReceived:
type: integer type: integer
format: int64 format: int64
@ -975,7 +975,7 @@ components:
description: Same as packetsReceivedUndecrypt, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) description: Same as packetsReceivedUndecrypt, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)
usPacketsSendPeriod: usPacketsSendPeriod:
type: number type: number
format: float64 format: double
description: Current minimum time interval between which consecutive packets are sent, in microseconds description: Current minimum time interval between which consecutive packets are sent, in microseconds
packetsFlowWindow: packetsFlowWindow:
type: integer type: integer
@ -987,19 +987,19 @@ components:
description: The number of packets in flight description: The number of packets in flight
msRTT: msRTT:
type: number type: number
format: float64 format: double
description: Smoothed round-trip time (SRTT), an exponentially-weighted moving average (EWMA) of an endpoint's RTT samples, in milliseconds description: Smoothed round-trip time (SRTT), an exponentially-weighted moving average (EWMA) of an endpoint's RTT samples, in milliseconds
mbpsSendRate: mbpsSendRate:
type: number type: number
format: float64 format: double
description: Current transmission bandwidth, in Mbps description: Current transmission bandwidth, in Mbps
mbpsReceiveRate: mbpsReceiveRate:
type: number type: number
format: float64 format: double
description: Current receiving bandwidth, in Mbps description: Current receiving bandwidth, in Mbps
mbpsLinkCapacity: mbpsLinkCapacity:
type: number type: number
format: float64 format: double
description: Estimated capacity of the network link, in Mbps description: Estimated capacity of the network link, in Mbps
bytesAvailSendBuf: bytesAvailSendBuf:
type: integer type: integer
@ -1011,7 +1011,7 @@ components:
description: The available space in the receiver's buffer, in bytes description: The available space in the receiver's buffer, in bytes
mbpsMaxBW: mbpsMaxBW:
type: number type: number
format: float64 format: double
description: Transmission bandwidth limit, in Mbps description: Transmission bandwidth limit, in Mbps
byteMSS: byteMSS:
type: integer type: integer
@ -1059,11 +1059,11 @@ components:
description: Accumulated difference between the current time and the time-to-play of a packet that is received late description: Accumulated difference between the current time and the time-to-play of a packet that is received late
packetsSendLossRate: packetsSendLossRate:
type: number type: number
format: float64 format: double
description: Percentage of resent data vs. sent data description: Percentage of resent data vs. sent data
packetsReceivedLossRate: packetsReceivedLossRate:
type: number type: number
format: float64 format: double
description: Percentage of retransmitted data vs. received data description: Percentage of retransmitted data vs. received data
SRTConnList: SRTConnList:
@ -1119,7 +1119,7 @@ components:
format: int64 format: int64
rtpPacketsJitter: rtpPacketsJitter:
type: number type: number
format: float64 format: double
rtcpPacketsReceived: rtcpPacketsReceived:
type: integer type: integer
format: int64 format: int64

View file

@ -171,7 +171,7 @@ func TestAPIDocs(t *testing.T) {
content2.Properties[js] = openAPIProperty{Type: "integer", Format: "int64"} content2.Properties[js] = openAPIProperty{Type: "integer", Format: "int64"}
case sf.Type == reflect.TypeOf(float64(0)): case sf.Type == reflect.TypeOf(float64(0)):
content2.Properties[js] = openAPIProperty{Type: "number", Format: "float64"} content2.Properties[js] = openAPIProperty{Type: "number", Format: "double"}
case sf.Type == reflect.TypeOf(false): case sf.Type == reflect.TypeOf(false):
content2.Properties[js] = openAPIProperty{Type: "boolean"} content2.Properties[js] = openAPIProperty{Type: "boolean"}