External/mediamtx
1
0
Fork 1
mirror of https://github.com/bluenviron/mediamtx.git synced 2025-12-20 02:00:05 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

apidocs: add missing format to integers and floats (#4796)
Some checks failed
code_lint / golangci_lint (push) Has been cancelled
Details
code_lint / mod_tidy (push) Has been cancelled
Details
code_lint / api_docs (push) Has been cancelled
Details
code_test / test_64 (push) Has been cancelled
Details
code_test / test_32 (push) Has been cancelled
Details
code_test / test_e2e (push) Has been cancelled
Details

Browse source
This commit is contained in:
Alessandro Ros 2025-07-27 20:45:09 +02:00 • committed by GitHub
parent 98f7a749de
commit e15795b1be
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 48 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

43
apidocs/openapi.yaml
View file

@ -65,8 +65,10 @@ components:
type: string type: string
writeQueueSize: writeQueueSize:
type: integer type: integer
format: int64
udpMaxPayloadSize: udpMaxPayloadSize:
type: integer type: integer
format: int64
runOnConnect: runOnConnect:
type: string type: string
runOnConnectRestart: runOnConnectRestart:
@ -193,16 +195,20 @@ components:
type: string type: string
multicastRTPPort: multicastRTPPort:
type: integer type: integer
format: int64
multicastRTCPPort: multicastRTCPPort:
type: integer type: integer
format: int64
srtpAddress: srtpAddress:
type: string type: string
srtcpAddress: srtcpAddress:
type: string type: string
multicastSRTPPort: multicastSRTPPort:
type: integer type: integer
format: int64
multicastSRTCPPort: multicastSRTCPPort:
type: integer type: integer
format: int64
rtspServerKey: rtspServerKey:
type: string type: string
rtspServerCert: rtspServerCert:
@ -249,6 +255,7 @@ components:
type: string type: string
hlsSegmentCount: hlsSegmentCount:
type: integer type: integer
format: int64
hlsSegmentDuration: hlsSegmentDuration:
type: string type: string
hlsPartDuration: hlsPartDuration:
@ -336,6 +343,7 @@ components:
type: string type: string
maxReaders: maxReaders:
type: integer type: integer
format: int64
srtReadPassphrase: srtReadPassphrase:
type: string type: string
fallback: fallback:
@ -382,24 +390,31 @@ components:
# Raspberry Pi Camera source # Raspberry Pi Camera source
rpiCameraCamID: rpiCameraCamID:
type: integer type: integer
format: int64
rpiCameraSecondary: rpiCameraSecondary:
type: boolean type: boolean
rpiCameraWidth: rpiCameraWidth:
type: integer type: integer
format: int64
rpiCameraHeight: rpiCameraHeight:
type: integer type: integer
format: int64
rpiCameraHFlip: rpiCameraHFlip:
type: boolean type: boolean
rpiCameraVFlip: rpiCameraVFlip:
type: boolean type: boolean
rpiCameraBrightness: rpiCameraBrightness:
type: number type: number
format: float64
rpiCameraContrast: rpiCameraContrast:
type: number type: number
format: float64
rpiCameraSaturation: rpiCameraSaturation:
type: number type: number
format: float64
rpiCameraSharpness: rpiCameraSharpness:
type: number type: number
format: float64
rpiCameraExposure: rpiCameraExposure:
type: string type: string
rpiCameraAWB: rpiCameraAWB:
@ -410,16 +425,20 @@ components:
maxItems: 2 maxItems: 2
items: items:
type: number type: number
format: float64
rpiCameraDenoise: rpiCameraDenoise:
type: string type: string
rpiCameraShutter: rpiCameraShutter:
type: integer type: integer
format: int64
rpiCameraMetering: rpiCameraMetering:
type: string type: string
rpiCameraGain: rpiCameraGain:
type: number type: number
format: float64
rpiCameraEV: rpiCameraEV:
type: number type: number
format: float64
rpiCameraROI: rpiCameraROI:
type: string type: string
rpiCameraHDR: rpiCameraHDR:
@ -430,6 +449,7 @@ components:
type: string type: string
rpiCameraFPS: rpiCameraFPS:
type: number type: number
format: float64
rpiCameraAfMode: rpiCameraAfMode:
type: string type: string
rpiCameraAfRange: rpiCameraAfRange:
@ -438,10 +458,12 @@ components:
type: string type: string
rpiCameraLensPosition: rpiCameraLensPosition:
type: number type: number
format: float64
rpiCameraAfWindow: rpiCameraAfWindow:
type: string type: string
rpiCameraFlickerPeriod: rpiCameraFlickerPeriod:
type: integer type: integer
format: int64
rpiCameraTextOverlayEnable: rpiCameraTextOverlayEnable:
type: boolean type: boolean
rpiCameraTextOverlay: rpiCameraTextOverlay:
@ -450,8 +472,10 @@ components:
type: string type: string
rpiCameraIDRPeriod: rpiCameraIDRPeriod:
type: integer type: integer
format: int64
rpiCameraBitrate: rpiCameraBitrate:
type: integer type: integer
format: int64
rpiCameraHardwareH264Profile: rpiCameraHardwareH264Profile:
type: string type: string
rpiCameraHardwareH264Level: rpiCameraHardwareH264Level:
@ -462,6 +486,7 @@ components:
type: string type: string
rpiCameraMJPEGQuality: rpiCameraMJPEGQuality:
type: integer type: integer
format: int64
# Hooks # Hooks
runOnInit: runOnInit:
@ -500,8 +525,10 @@ components:
properties: properties:
pageCount: pageCount:
type: integer type: integer
format: int64
itemCount: itemCount:
type: integer type: integer
format: int64
items: items:
type: array type: array
items: items:
@ -542,8 +569,10 @@ components:
properties: properties:
pageCount: pageCount:
type: integer type: integer
format: int64
itemCount: itemCount:
type: integer type: integer
format: int64
items: items:
type: array type: array
items: items:
@ -604,8 +633,10 @@ components:
properties: properties:
pageCount: pageCount:
type: integer type: integer
format: int64
itemCount: itemCount:
type: integer type: integer
format: int64
items: items:
type: array type: array
items: items:
@ -626,8 +657,10 @@ components:
properties: properties:
pageCount: pageCount:
type: integer type: integer
format: int64
itemCount: itemCount:
type: integer type: integer
format: int64
items: items:
type: array type: array
items: items:
@ -667,8 +700,10 @@ components:
properties: properties:
pageCount: pageCount:
type: integer type: integer
format: int64
itemCount: itemCount:
type: integer type: integer
format: int64
items: items:
type: array type: array
items: items:
@ -698,8 +733,10 @@ components:
properties: properties:
pageCount: pageCount:
type: integer type: integer
format: int64
itemCount: itemCount:
type: integer type: integer
format: int64
items: items:
type: array type: array
items: items:
@ -760,8 +797,10 @@ components:
properties: properties:
pageCount: pageCount:
type: integer type: integer
format: int64
itemCount: itemCount:
type: integer type: integer
format: int64
items: items:
type: array type: array
items: items:
@ -999,8 +1038,10 @@ components:
properties: properties:
pageCount: pageCount:
type: integer type: integer
format: int64
itemCount: itemCount:
type: integer type: integer
format: int64
items: items:
type: array type: array
items: items:
@ -1040,8 +1081,10 @@ components:
properties: properties:
pageCount: pageCount:
type: integer type: integer
format: int64
itemCount: itemCount:
type: integer type: integer
format: int64
items: items:
type: array type: array
items: items:

6
internal/testapidocs/apidocs_test.go
View file

@ -16,6 +16,7 @@ import (
type openAPIProperty struct { type openAPIProperty struct {
Ref string `json:"$ref"` Ref string `json:"$ref"`
Type string `json:"type"` Type string `json:"type"`
Format string `json:"format"`
Nullable bool `json:"nullable"` Nullable bool `json:"nullable"`
Items *openAPIProperty `json:"items"` Items *openAPIProperty `json:"items"`
} }
@ -157,7 +158,10 @@ func TestAPIDocs(t *testing.T) {
content2.Properties[js] = openAPIProperty{Type: "string"} content2.Properties[js] = openAPIProperty{Type: "string"}
case sf.Type == reflect.TypeOf(int(0)): case sf.Type == reflect.TypeOf(int(0)):
content2.Properties[js] = openAPIProperty{Type: "integer"} content2.Properties[js] = openAPIProperty{Type: "integer", Format: "int64"}
case sf.Type == reflect.TypeOf(float64(0)):
content2.Properties[js] = openAPIProperty{Type: "number", Format: "float64"}
case sf.Type == reflect.TypeOf(false): case sf.Type == reflect.TypeOf(false):
content2.Properties[js] = openAPIProperty{Type: "boolean"} content2.Properties[js] = openAPIProperty{Type: "boolean"}