How to validate an array with optional objects keys inside that must be checked for required keys themselves in Karate?

Question

I am trying to validate an API response schema with this structure in Karate:

{
  "payoutQuotes": [ //could be empty or not but when not empty must have the required object structure inside
    {
      "customerDomain": {
        "financialAccountData": { 
          "payoutQuoteId": "#number",
          "payoutQuoteExpiryDate": "#? isValidDate(_)",
          "totalAmountOfPayoutQuote": "#number",
          "payoutQuoteCreateDate": "#? isValidDate(_)",
          "payoutRequestedBy": "#string"
        }
      }
    }
  ]
}

Now if the response returns an empty "payoutQuotes" array then it is acceptable but when it also contains the object(s) inside, I want to check they have the proper required key-value combinations. Please note that I have this schema saved as a separate file in my data folder of the project to be used for my schema validation.

Peter Thomas · Accepted Answer · 2022-03-18 04:53:04Z

1

Here's the approach, it should be simple. You can read the value of quote from a single file.

* def quote = { foo: '#string' }
* def response1 = { payout: [] }
* def response2 = { payout: [{ foo: 'bar' }] }
* match response1 == { payout: '#[] quote' }
* match response2 == { payout: '#[] quote' }

answered Mar 18, 2022 at 4:53

Peter Thomas

58.4k32 gold badges100 silver badges342 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Mo Pishdar Over a year ago

As you suggested I have updated my schema Json file to be a subschema that validates the object inside the array and wrote my evaluation line as: And match response == {"payoutQuotes": '#[] PayoutQuoteHistorySuccessSchema'} And it worked... thank you @peter

Collectives™ on Stack Overflow

How to validate an array with optional objects keys inside that must be checked for required keys themselves in Karate?

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related