Swagger 给出结构性错误

Question

我在 openAPI 3.0 中遇到以下错误：

Structural error at components.schemas.put_400.properties.errors
should NOT have additional properties
additionalProperty: readonly
Jump to line 1613
Structural error at components.schemas.patch_400.properties.errors
should NOT have additional properties
additionalProperty: success
Jump to line 1648

这是错误发生的地方（对于第一个）：

"put_400": {
            "description": "Bad Request. Failed to validate the payload",
            "type": "object",
            "example": {
                "errors": [
                    "serialId: serialId is required"
                ],
                "success": false
            },
            "properties": {
                "errors": {
                    "type": "object",
                    "readonly": true
                },
                "success": {
                    "type": "boolean",
                    "example": false
                }
            }
        }

第二个：

   "patch_400": {
                "description": "Bad Request. Failed to validate the payload.",
                "type": "object",
                "example": {
                    "message": "invalid character \n in string literal",
                    "success": false
                },
                "properties": {
                    "message": {
                        "type": "object",
                        "readOnly": true
                    },
                    "errors": {
                        "type": "object",
                        "success": "false;" 
                    }
                }
            }

我在互联网上找不到太多。任何帮助，将不胜感激。谢谢。

Answer 1

要修复第一个错误，请将 readonly 更改为 readOnly（使用大写 O）。

至于第二个错误，我想你需要改变

"errors": {
  "type": "object",
  "success": "false;"
}

到

"success": {
  "type": "boolean",
  "example": false
}

用于 put_400。

Swagger 给出结构性错误

Swagger give Structural errors

swagger

openapi