Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

request.query.settings should be object

See original GitHub issue

Hello,

Is serialized objects not supported or am I doing something wrong? I have an endpoint defined like that ( I deliberately simplified this ) :

  /api/someGet:
    get:
      summary: "Retrieve something"
      parameters:
        - in: query
          style: form
          name: settings
          explode: true
          schema:
            allOf:
              - type: object
                properties:
                  onlyValidated:
                    type: boolean
                    default: true
                  onlySelected:
                    type: array
                    default: []
                    uniqueItems: true
                    items:
                      type: integer
                      minimum: 0
                      example: 42
      responses:
        '200':
          description: "An array of items"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/someItem"
                uniqueItems: true

I tested two approaches that have failed with Postman ( that imported the api definition ) :

{{baseUrl}}/api/someGet?settings={“onlyValidated”:true}

{
    "message": "request.query.settings should be object",
    "errors": [
        {
            "path": ".query.settings",
            "message": "should be object",
            "errorCode": "type.openapi.validation"
        }
    ]
}

{{baseUrl}}/api/someGet?onlyValidated=true

{
    "message": "Unknown query parameter onlyValidated",
    "errors": [
        {
            "path": ".query.onlyValidated",
            "message": "Unknown query parameter onlyValidated"
        }
    ]
}

FYI, here is my express server implementation :

const express = require('express');
const path = require('path');
const logger = require('morgan');
const cookieParser = require('cookie-parser');
const bodyParser = require('body-parser');

const routes = require('./routes/index');

// miscellaneous passport things
const passport = require('passport');


// OpenAPI V3 validation middleware
const OpenApiValidator = require('express-openapi-validator').OpenApiValidator;
const spec = path.join(__dirname, 'api.yml');

// Initialize passport ( Passport is a singleton )
require('./config/passport');

const app = express();

// middleware
app.use(logger('dev'));
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.use(cookieParser());

// API validation before routes and password.js
// Install the OpenApiValidator on your express app
new OpenApiValidator({
    apiSpec: spec,
    validateRequests: true,
    validateResponses: false,
    // securityHandlers: {
    //   ApiKeyAuth: (req, scopes, schema) => true,
    // },
}).install(app);

// Passport Js must have that
app.use(passport.initialize());

// routes
app.use('/', routes);

// catch 404 and forward to error handler
app.use(function(req, res, next) {
    let err = new Error('Not Found');
    err.status = 404;
    next(err);
});

// error handler
// no stacktraces leaked to user unless in development environment
app.use(function(err, req, res, next) {

    // if error thrown by validation, give everything else depending of the environment
    res.status(err.status || 500).json({
        message: err.message,
        errors: err.hasOwnProperty("errors")
            ? err.errors
            : (app.get('env') === 'development') ? [err] : []
    });

});


module.exports = app;