|
73 | 73 | } |
74 | 74 | } |
75 | 75 | }, |
| 76 | + "/api/v1/integration/acoustics/mode": { |
| 77 | + "get": { |
| 78 | + "description": "Get acoustics mode (\"low-frequency\" or \"high-frequency\")", |
| 79 | + "tags": [ |
| 80 | + "acoustics", |
| 81 | + "integrationAPI" |
| 82 | + ], |
| 83 | + "responses": { |
| 84 | + "200": { |
| 85 | + "description": "OK", |
| 86 | + "schema": { |
| 87 | + "type": "string" |
| 88 | + } |
| 89 | + }, |
| 90 | + "204": { |
| 91 | + "description": "No Content" |
| 92 | + } |
| 93 | + } |
| 94 | + }, |
| 95 | + "post": { |
| 96 | + "description": "Set acoustics mode to either \"low-frequency\" or \"high-frequency\"", |
| 97 | + "tags": [ |
| 98 | + "acoustics", |
| 99 | + "integrationAPI" |
| 100 | + ], |
| 101 | + "parameters": [ |
| 102 | + { |
| 103 | + "description": " ", |
| 104 | + "name": "request", |
| 105 | + "in": "body", |
| 106 | + "required": true, |
| 107 | + "schema": { |
| 108 | + "type": "string", |
| 109 | + "enum": [ |
| 110 | + "\"low-frequency\"", |
| 111 | + "\"high-frequency\"" |
| 112 | + ], |
| 113 | + "example": "\"low-frequency\"" |
| 114 | + } |
| 115 | + } |
| 116 | + ], |
| 117 | + "responses": { |
| 118 | + "204": { |
| 119 | + "description": "No Content" |
| 120 | + }, |
| 121 | + "400": { |
| 122 | + "description": "Bad Request" |
| 123 | + }, |
| 124 | + "408": { |
| 125 | + "description": "Request Timeout" |
| 126 | + }, |
| 127 | + "500": { |
| 128 | + "description": "Internal Server Error" |
| 129 | + } |
| 130 | + } |
| 131 | + } |
| 132 | + }, |
76 | 133 | "/api/v1/integration/acoustics/range": { |
77 | 134 | "get": { |
78 | 135 | "description": "Get range", |
|
122 | 179 | } |
123 | 180 | } |
124 | 181 | }, |
| 182 | + "/api/v1/integration/acoustics/salinity": { |
| 183 | + "get": { |
| 184 | + "description": "Get salinity for automatic speed of sound calculation. \"fresh\" or \"salt\".", |
| 185 | + "tags": [ |
| 186 | + "acoustics", |
| 187 | + "integrationAPI" |
| 188 | + ], |
| 189 | + "responses": { |
| 190 | + "200": { |
| 191 | + "description": "OK", |
| 192 | + "schema": { |
| 193 | + "type": "string" |
| 194 | + } |
| 195 | + }, |
| 196 | + "204": { |
| 197 | + "description": "No Content" |
| 198 | + } |
| 199 | + } |
| 200 | + }, |
| 201 | + "post": { |
| 202 | + "description": "Set salinity for automatic speed of sound calculation. \"fresh\" or \"salt\".", |
| 203 | + "tags": [ |
| 204 | + "acoustics", |
| 205 | + "integrationAPI" |
| 206 | + ], |
| 207 | + "parameters": [ |
| 208 | + { |
| 209 | + "description": " ", |
| 210 | + "name": "request", |
| 211 | + "in": "body", |
| 212 | + "required": true, |
| 213 | + "schema": { |
| 214 | + "type": "string", |
| 215 | + "enum": [ |
| 216 | + "\"fresh\"", |
| 217 | + "\"salt\"" |
| 218 | + ], |
| 219 | + "example": "\"salt\"" |
| 220 | + } |
| 221 | + } |
| 222 | + ], |
| 223 | + "responses": { |
| 224 | + "204": { |
| 225 | + "description": "No Content" |
| 226 | + }, |
| 227 | + "400": { |
| 228 | + "description": "Bad Request" |
| 229 | + }, |
| 230 | + "408": { |
| 231 | + "description": "Request Timeout" |
| 232 | + }, |
| 233 | + "409": { |
| 234 | + "description": "Conflict" |
| 235 | + } |
| 236 | + } |
| 237 | + } |
| 238 | + }, |
125 | 239 | "/api/v1/integration/acoustics/speed_of_sound": { |
126 | 240 | "get": { |
127 | | - "description": "Get speed of sound", |
| 241 | + "description": "Get speed of sound. 0 means speed of sound is automatically calculated from configured water salinity and water temperature.", |
128 | 242 | "tags": [ |
129 | 243 | "acoustics", |
130 | 244 | "integrationAPI" |
|
142 | 256 | } |
143 | 257 | }, |
144 | 258 | "post": { |
145 | | - "description": "Set speed of sound", |
| 259 | + "description": "Set speed of sound. 0 means speed of sound is automatically calculated from configured water salinity and water temperature.", |
146 | 260 | "tags": [ |
147 | 261 | "acoustics", |
148 | 262 | "integrationAPI" |
|
294 | 408 | } |
295 | 409 | ] |
296 | 410 | }, |
297 | | - "calibration": { |
298 | | - "description": "Calibration is the status of the Sonar calibration", |
| 411 | + "systems_check": { |
| 412 | + "description": "SystemsCheck is the status of internal processing of the Sonar", |
299 | 413 | "allOf": [ |
300 | 414 | { |
301 | 415 | "$ref": "#/definitions/integrationapi.GinSystemStatusEntryResponse" |
|
330 | 444 | "type": "boolean", |
331 | 445 | "example": true |
332 | 446 | }, |
333 | | - "severity": { |
334 | | - "description": "Severity is the severity of the status message: info, warning, error", |
| 447 | + "status": { |
| 448 | + "description": "Status is \"ok\", \"warning\", or \"error\"", |
335 | 449 | "type": "string", |
336 | | - "example": "info" |
| 450 | + "example": "ok" |
337 | 451 | } |
338 | 452 | } |
339 | 453 | }, |
|
0 commit comments