oneOf appears to not work correctly (Being treated like allOf)

オープン

#269 2020年5月22日に作成コメント 0 件リアクション 0 件担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度: 3/5
見積もり時間: 1〜2日
初心者へのやさしさ: 35/100

issue の種類: バグ
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: java
領域: devtools

調査の方向性

まず、VpcLinkId と BaseURI を含む schema と payload で、報告された update validation failure を再現します。oneOf の分岐がちょうど 1 つ、両方、どちらもない場合の validation 結果を比較します。1 つの有効な分岐が受け入れられ、無効な組み合わせでは期待どおりのエラーが生成されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Version 1.0.5 of the Java plugin

Schema:

{
    "typeName": "OBFUSCATED::ApiGateway::RestApi",
    "description": "An example resource schema demonstrating some basic constructs and validation rules.",
    "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git",
    "properties": {
        "RestApiId": {
            "type": "string"
        },
        "Name": {
            "description": "Api Name",
            "type": "string"
        },
        "AuthorizerLambdaArn": {
            "type": "string"
        },
        "AuthorizerCredentials": {
            "type": "string"
        },
        "Version": {
            "type": "string"
        },
        "SwaggerS3Location": {
            "description": "Swagger File S3 Location.",
            "type": "object",
            "properties": {
                "Bucket": {
                    "type": "string"
                },
                "Key": {
                    "type": "string"
                },
                "Version" : {
                    "type": "string"
                }
            },
            "required": [
                "Bucket",
                "Key"
            ]

        },
        "EndpointType": {
            "description": "Gateway Endpoint Type",
            "enum" : ["REGIONAL", "EDGE", "PRIVATE"],
            "type": "string"
        },
        "ValidateRequests" : {
            "type": "boolean",
            "description" : "Use Api Gateway request validatoin"
        }
    },
    "oneOf": [
        {
            "properties": {
                "VpcLinkId": {
                    "type": "string"
                },
                "BaseURI": {
                    "type": "string"
                }
            },
            "required":  ["VpcLinkId", "BaseURI"]
        },
        {
            "properties": {
                "LambdaArn" : {
                    "type": "string"
                }
            },
            "required" : ["LambdaArn"]
        }
    ],
    "additionalProperties": false,
    "required": [
        "Name",
        "SwaggerS3Location",
        "EndpointType",
        "AuthorizerLambdaArn",
        "AuthorizerCredentials"
    ],
    "writeOnlyProperties": [
        "/properties/VpcLinkId",
        "/properties/BaseURI",
        "/properties/LambdaArn",
        "/properties/SwaggerS3Location",
        "/properties/ValidateRequests"
    ],
    "readOnlyProperties": [
        "/properties/RestApiId",
        "/properties/Version"
    ],
    "primaryIdentifier": [
        "/properties/RestApiId"
    ],
    "handlers": {
        "create": {
            "permissions": [
                "iam:PassRole",
                "s3:GetObject",
                "s3:GetBucketLocation",
                "apigateway:PATCH",
                "apigateway:POST",
                "apigateway:PUT"
            ]
        },
        "read": {
            "permissions": [
                "apigateway:GET"
            ]
        },
        "update": {
            "permissions": [
                "iam:PassRole",
                "s3:GetObject",
                "s3:GetBucketLocation",
                "apigateway:PATCH",
                "apigateway:POST",
                "apigateway:PUT"
            ]
        },
        "delete": {
            "permissions": [
                "apigateway:DELETE"
            ]
        }
    }
}

Error when using only VpcLinkId and BaseURI in an update operation:

Model validation failed (#: #: only 1 subschema matches out of 2)\n#: 2 schema violations found (#)