RAML validation for json array

Question

In my API RAML, there is a query parameter named 'sfIds' which is an array type. I need to implement validation within the RAML to ensure that the array elements are always numeric, such as [111, 222, 333] or [111]. An array such as [ABC,111] should not pass RAML validation.

Is there a way to define "types" for this validation?

Below is a segment of my RAML code; please be aware that this is just a portion of the full RAML. It is not functioning as anticipated in my Mule flow.

#%RAML 1.0
title: My Test API
version: v1
types:
  NumericArray:
    type: array
    items: number
/ids:
  get:
    queryParameters:
    sfIds?:
        type: NumericArray
        example: [111,222]

The error that I get in the Mule flow is:

Invalid value '[111,222]' for query parameter sfIds. /0 expected type: Number, found: JSONArray"

Since the issue is happening in a Mule application it would be helpful to provide details of Mule version, APIKit version, the URL used, the complete error message and maybe details of the flow and configurations related to the issue. — aled
– aled, Commented Apr 24, 2024 at 15:09

Karthik · Accepted Answer · 2024-04-24 14:43:53Z

0

You can try with mentioning more specific type like number[] which is an Array of Number

#%RAML 1.0
title: My Test API
version: v1
types:
  NumericArray:
    type: number[]
/ids:
  get:
    queryParameters:
      sfIds?:
        type: NumericArray
        example: [111,222]

Url to access the above -> /api/ids?sfIds=123&sfIds=234 which will result in [123,234] when you access it using valuesOf(attributes.queryParams)

edited Apr 24, 2024 at 14:43

answered Apr 24, 2024 at 13:41

Karthik

2,4274 gold badges14 silver badges32 bronze badges

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

3 Comments

Triumph Spitfire Over a year ago

Thanks for sharing. I tried this but getting an exception in the API. "exceptionMessage": "org.mule.module.apikit.api.exception.InvalidQueryParameterException:Invalid value '[1235]' for query parameter sfIds. /0 expected type: Number, found: JSONArray" Please advise

Karthik Over a year ago

@TriumphSpitfire how are you accesing the url?? I have added the url in answer.. that is the right format

Karthik Over a year ago

I think you can not pass something like /api/ids?sfIds=[111,222] to validate array of numbers @TriumphSpitfire

Triumph Spitfire · Accepted Answer · 2024-05-02 17:24:43Z

0

I have managed to get this working. Here is the RAML that is now functioning.

#%RAML 1.0
title: My Test API
version: v1
types:
  NumericArray:
    type: array
    items: number
    minItems: 1
/ids:
  get:
    queryParameters:
      sfIds?:
        type: array
        items:
         type: NumericArray

answered May 2, 2024 at 17:24

Triumph Spitfire

6451 gold badge19 silver badges42 bronze badges

Collectives™ on Stack Overflow

RAML validation for json array

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related