Array of integers detected as a String?

[jp-tosca]

I was validating my document with doctor and I am getting the following warning on the console:

"manifestStoredResourceId" : {
            "type" : "array",
            "description" : "The list of storage id for the manifests of the external tool",
            "example" : [ 1, 2, 3 ],
            "items" : {
              "type" : "integer",
              "format" : "int64"
            }
          }

`got string, want integer

Location: components.schemas['ExternalToolDTO'].properties['versions'].items.properties['manifestStoredResourceId'].example
Rule: oas3-valid-schema-example`

Is this a bug or I am doing something wrong on my side?

openapi.json

[LasneF]

@daveshanley looks quite strange , the doctor looks sick :( as same file going to vacum gives no Error

vacuum lint '.\openapi (2).json' --no-clip

version: 0.15.2 | compiled: Tue, 07 Jan 2025 15:30:04 UTC
🔗 https://quobix.com/vacuum | https://github.com/daveshanley/vacuum

INFO Linting file '.\openapi (2).json' against 48 rules: https://quobix.com/vacuum/rulesets/recommended

      Linting passed, A perfect score! well done!                                                                     

INFO To see full details of linting report, use the '-d' flag.

@jp-tosca , btw your files got few glinch leveraging redocly like

Example value must conform to the schema: 1 property must NOT have unevaluated properties imagesResourceId.

930 | "manifestStoredResourceId" : [ 3 ]
931 | } ],
932 | "imagesResourceId" : [ 4 ]
933 | } ]
934 | }

and

[3] openapi (2).json:668:19 at #/paths/1api1auth1login/post/responses/200/content/application1json/example/tokenType

Example value must conform to the schema: must NOT have unevaluated properties tokenType.

666 | "roles" : [ "ADMIN" ],
667 | "accessToken" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqcHRvc2NhIiwiaWF0IjoxNzM4MzQzMDcyLCJleHAiOjE3Mzg0Mjk0NzJ9.6phCugWMc5i...<16 chars>
668 | "tokenType" : "Bearer"
669 | }
670 | }

@daveshanley this rules could be interesting to have by default as a warning , or info

[daveshanley]

This is a fixed bug in vacuum: daveshanley/vacuum#615

I have not yet updated the doctor, will do that today.

[jp-tosca]

Thanks a lot @daveshanley !

I also was wondering about one thing, I use SpringDocs to generate my document and one annotation provided is @ArraySchema that I am using like this:

@ArraySchema(
        schema = @Schema(description = "Manifest files for the default versionof the new external tool", 
            type = "array",
            contentMediaType = "multipart/form-data",
            implementation = MultipartFile.class,
            nullable = false,
            example = "[\"file1.json\",\"file2.json\"]"),
        minItems = 1
    )

Which produces something like this:

 "jsonData" : {
            "type" : "array",
            "items" : {
              "type" : "string",
              "format" : "binary",
              "contentMediaType" : "multipart/form-data",
              "description" : "Manifest files for the default versionof the new external tool",
              "example" : "file.json",
              "minItems" : 1
            },
            "minItems" : 1
          },

I been trying with different values with the example but I always get schema is missing examples or example oas3-missing-example which I can fix if I remove manually the example from the array and move it into the jsonData definition like this:

"jsonData" : {
            "type" : "array",
            "items" : {
              "type" : "string",
              "format" : "binary",
              "contentMediaType" : "multipart/form-data",
              "description" : "Manifest files for the default versionof the new external tool",              
              "minItems" : 1
            },
            "minItems" : 1,
            "example" : ["file.json"],
          },

The issue is that @ArraySchema doesn't provide an example property so I was wondering what would be the valid way to include this example 🤔

Thanks again!

update

If anyone else is curious I solved this by not using the @ArraySchema and using this instead:

@Schema(description = "Manifest files for the default versionof the new external tool", 
            type = "array",
            contentMediaType = "multipart/form-data",
            implementation = MultipartFile[].class,
            nullable = false,
            example = "[\"file.json\"]")

So I am not sure if @ArraySchema should have an example field or put the example at the upper level.