From 9a2a7306349990403199ff55602687eeaf700dad Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 20 Jul 2026 18:47:30 +0000 Subject: [PATCH] docs(openapi): remove stale result envelope from response schemas (#31989) --- server/mcp/openapi.json | 213 +++++++++------------------------------- server/openapi.yaml | 157 +++++++++-------------------- 2 files changed, 93 insertions(+), 277 deletions(-) diff --git a/server/mcp/openapi.json b/server/mcp/openapi.json index 0c051c109..fa4803c03 100644 --- a/server/mcp/openapi.json +++ b/server/mcp/openapi.json @@ -199,15 +199,10 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "description": "Battery mode. 0: unknown, 1: normal, 2: hold, 3: charge, 4: holdcharge", - "maximum": 4, - "minimum": 0, - "type": "integer" - } - }, - "type": "object" + "description": "Battery mode. 0: unknown, 1: normal, 2: hold, 3: charge, 4: holdcharge", + "maximum": 4, + "minimum": 0, + "type": "integer" } } }, @@ -220,12 +215,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "type": "boolean" - } - }, - "type": "object" + "type": "boolean" } } }, @@ -245,12 +235,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "type": "integer" - } - }, - "type": "object" + "type": "integer" } } }, @@ -260,12 +245,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "type": "integer" - } - }, - "type": "object" + "type": "integer" } } }, @@ -275,13 +255,8 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "description": "Value is always null", - "nullable": true, - "type": "object" - } - }, + "description": "Value is always null", + "nullable": true, "type": "object" } } @@ -292,12 +267,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "type": "number" - } - }, - "type": "object" + "type": "number" } } }, @@ -307,12 +277,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "$ref": "#/components/schemas/PlanRates" - } - }, - "type": "object" + "$ref": "#/components/schemas/PlanRates" } } }, @@ -323,13 +288,8 @@ "application/json": { "schema": { "properties": { - "result": { - "properties": { - "soc": { - "$ref": "#/components/schemas/Soc" - } - }, - "type": "object" + "soc": { + "$ref": "#/components/schemas/Soc" } }, "type": "object" @@ -342,13 +302,8 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "example": "OK", - "type": "string" - } - }, - "type": "object" + "example": "OK", + "type": "string" } } }, @@ -1331,12 +1286,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "$ref": "#/components/schemas/GridSessions" - } - }, - "type": "object" + "$ref": "#/components/schemas/GridSessions" } }, "text/csv": { @@ -1788,12 +1738,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "$ref": "#/components/schemas/Mode" - } - }, - "type": "object" + "$ref": "#/components/schemas/Mode" } } }, @@ -1852,24 +1797,19 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "allOf": [ - { - "properties": { - "planId": { - "$ref": "#/components/schemas/Id" - } - }, - "type": "object" - }, - { - "$ref": "#/components/schemas/PlanRates" + "allOf": [ + { + "properties": { + "planId": { + "$ref": "#/components/schemas/Id" } - ] + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/PlanRates" } - }, - "type": "object" + ] } } }, @@ -1928,12 +1868,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "$ref": "#/components/schemas/StaticEnergyPlan" - } - }, - "type": "object" + "$ref": "#/components/schemas/StaticEnergyPlan" } } }, @@ -2066,12 +2001,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "$ref": "#/components/schemas/PlanStrategy" - } - }, - "type": "object" + "$ref": "#/components/schemas/PlanStrategy" } } }, @@ -2275,13 +2205,8 @@ "application/json": { "schema": { "properties": { - "result": { - "properties": { - "vehicle": { - "$ref": "#/components/schemas/VehicleTitle" - } - }, - "type": "object" + "vehicle": { + "$ref": "#/components/schemas/VehicleTitle" } }, "type": "object" @@ -2457,12 +2382,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "$ref": "#/components/schemas/ChargingSessions" - } - }, - "type": "object" + "$ref": "#/components/schemas/ChargingSessions" } }, "text/csv": { @@ -2630,12 +2550,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "$ref": "#/components/schemas/State" - } - }, - "type": "object" + "$ref": "#/components/schemas/State" } } }, @@ -2714,15 +2629,10 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "items": { - "type": "string" - }, - "type": "array" - } + "items": { + "type": "string" }, - "type": "object" + "type": "array" } }, "text/plain": { @@ -2762,12 +2672,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "$ref": "#/components/schemas/LogAreas" - } - }, - "type": "object" + "$ref": "#/components/schemas/LogAreas" } } }, @@ -2848,13 +2753,8 @@ "application/json": { "schema": { "properties": { - "result": { - "properties": { - "rates": { - "$ref": "#/components/schemas/Rates" - } - }, - "type": "object" + "rates": { + "$ref": "#/components/schemas/Rates" } }, "type": "object" @@ -3016,15 +2916,10 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "items": { - "$ref": "#/components/schemas/RepeatingPlan" - }, - "type": "array" - } + "items": { + "$ref": "#/components/schemas/RepeatingPlan" }, - "type": "object" + "type": "array" } } }, @@ -3084,16 +2979,11 @@ "application/json": { "schema": { "properties": { - "result": { - "properties": { - "soc": { - "$ref": "#/components/schemas/Soc" - }, - "time": { - "$ref": "#/components/schemas/Timestamp" - } - }, - "type": "object" + "soc": { + "$ref": "#/components/schemas/Soc" + }, + "time": { + "$ref": "#/components/schemas/Timestamp" } }, "type": "object" @@ -3136,12 +3026,7 @@ "content": { "application/json": { "schema": { - "properties": { - "result": { - "$ref": "#/components/schemas/PlanStrategy" - } - }, - "type": "object" + "$ref": "#/components/schemas/PlanStrategy" } } }, diff --git a/server/openapi.yaml b/server/openapi.yaml index d83dcecaa..77b2c9f6c 100644 --- a/server/openapi.yaml +++ b/server/openapi.yaml @@ -435,10 +435,7 @@ paths: content: application/json: schema: - type: object - properties: - result: - $ref: "#/components/schemas/Mode" + $ref: "#/components/schemas/Mode" /loadpoints/{id}/phases/{phases}: post: operationId: setLoadpointPhases @@ -473,15 +470,12 @@ paths: content: application/json: schema: - type: object - properties: - result: - allOf: - - type: object - properties: - planId: - $ref: "#/components/schemas/Id" - - $ref: "#/components/schemas/PlanRates" + allOf: + - type: object + properties: + planId: + $ref: "#/components/schemas/Id" + - $ref: "#/components/schemas/PlanRates" /loadpoints/{id}/plan/energy: delete: operationId: deleteLoadpointEnergyPlan @@ -515,10 +509,7 @@ paths: content: application/json: schema: - type: object - properties: - result: - $ref: "#/components/schemas/StaticEnergyPlan" + $ref: "#/components/schemas/StaticEnergyPlan" /loadpoints/{id}/plan/repeating/preview/{soc}/{weekdays}/{hourMinuteTime}/{timezone}: get: operationId: previewLoadpointRepeatingPlan @@ -592,10 +583,7 @@ paths: content: application/json: schema: - type: object - properties: - result: - $ref: "#/components/schemas/PlanStrategy" + $ref: "#/components/schemas/PlanStrategy" /loadpoints/{id}/priority/{priority}: post: operationId: setLoadpointPriority @@ -719,11 +707,8 @@ paths: schema: type: object properties: - result: - type: object - properties: - vehicle: - $ref: "#/components/schemas/VehicleTitle" + vehicle: + $ref: "#/components/schemas/VehicleTitle" /prioritysoc/{soc}: post: operationId: setPrioritySoc @@ -851,10 +836,7 @@ paths: content: application/json: schema: - type: object - properties: - result: - $ref: "#/components/schemas/GridSessions" + $ref: "#/components/schemas/GridSessions" text/csv: schema: description: Download csv-file @@ -903,10 +885,7 @@ paths: content: application/json: schema: - type: object - properties: - result: - $ref: "#/components/schemas/ChargingSessions" + $ref: "#/components/schemas/ChargingSessions" text/csv: schema: description: Download csv-file @@ -978,10 +957,7 @@ paths: content: application/json: schema: - type: object - properties: - result: - $ref: "#/components/schemas/State" + $ref: "#/components/schemas/State" /system/log: get: operationId: getSystemLogs @@ -1016,12 +992,9 @@ paths: content: application/json: schema: - type: object - properties: - result: - type: array - items: - type: string + type: array + items: + type: string text/plain: schema: description: Download txt-file @@ -1045,10 +1018,7 @@ paths: content: application/json: schema: - type: object - properties: - result: - $ref: "#/components/schemas/LogAreas" + $ref: "#/components/schemas/LogAreas" "401": $ref: "#/components/responses/Unauthorized" /system/cache: @@ -1111,11 +1081,8 @@ paths: schema: type: object properties: - result: - type: object - properties: - rates: - $ref: "#/components/schemas/Rates" + rates: + $ref: "#/components/schemas/Rates" "404": description: Tariff not defined /vehicles/{name}/limitsoc/{soc}: @@ -1209,12 +1176,9 @@ paths: content: application/json: schema: - type: object - properties: - result: - type: array - items: - $ref: "#/components/schemas/RepeatingPlan" + type: array + items: + $ref: "#/components/schemas/RepeatingPlan" /vehicles/{name}/plan/soc: delete: operationId: deleteVehicleSocPlan @@ -1250,13 +1214,10 @@ paths: schema: type: object properties: - result: - type: object - properties: - soc: - $ref: "#/components/schemas/Soc" - time: - $ref: "#/components/schemas/Timestamp" + soc: + $ref: "#/components/schemas/Soc" + time: + $ref: "#/components/schemas/Timestamp" /vehicles/{name}/plan/strategy: post: operationId: setVehiclePlanStrategy @@ -1280,10 +1241,7 @@ paths: content: application/json: schema: - type: object - properties: - result: - $ref: "#/components/schemas/PlanStrategy" + $ref: "#/components/schemas/PlanStrategy" /db/backup: get: operationId: downloadBackup @@ -1916,28 +1874,19 @@ components: content: application/json: schema: - type: object - properties: - result: - type: integer + type: integer NumberResult: description: Success - Number result content: application/json: schema: - type: object - properties: - result: - type: number + type: number IntegerResult: description: Success - Integer result content: application/json: schema: - type: object - properties: - result: - type: integer + type: integer SocResult: description: Success - Soc result content: @@ -1945,40 +1894,28 @@ components: schema: type: object properties: - result: - type: object - properties: - soc: - $ref: "#/components/schemas/Soc" + soc: + $ref: "#/components/schemas/Soc" PlanRatesResult: description: Success - PlanRates result content: application/json: schema: - type: object - properties: - result: - $ref: "#/components/schemas/PlanRates" + $ref: "#/components/schemas/PlanRates" BooleanResult: description: Success - Boolean result content: application/json: schema: - type: object - properties: - result: - type: boolean + type: boolean NullResult: description: Success - Null result content: application/json: schema: - type: object - properties: - result: - description: Value is always null - nullable: true - type: "object" + description: Value is always null + nullable: true + type: "object" BlankResponse: description: Success - Blank response SuccessResult: @@ -1986,11 +1923,8 @@ components: content: application/json: schema: - type: object - properties: - result: - type: string - example: "OK" + type: string + example: "OK" EmptyResult: description: Success - Empty result content: @@ -2010,13 +1944,10 @@ components: content: application/json: schema: - type: object - properties: - result: - type: integer - description: "Battery mode. 0: unknown, 1: normal, 2: hold, 3: charge, 4: holdcharge" - minimum: 0 - maximum: 4 + type: integer + description: "Battery mode. 0: unknown, 1: normal, 2: hold, 3: charge, 4: holdcharge" + minimum: 0 + maximum: 4 securitySchemes: cookieAuth: type: apiKey