Custom Route Configuration - not working as expected

[RotemBot]

This is my route definition:

'POST /api/v1/projects/:project_id/assignments': {
    controller: 'AssignmentController',
    action: 'create',
    swagger: {
      summary: 'Creating a new Annotation Assignment',
      description: 'Create a new annotation assignment and assign tasks to annotators',
      body: {
        title: {
          type: 'string',
          required: true
        },
        description: {
          type: 'string',
          required: true
        },
        dataset_id: {
          type: 'string',
          required: true
        },
        sample_dataset: {
          type: 'string',
          required: true
        },
        annotators: {
          type: 'json',
          required: true
        }
      },
      parameters: [{
        in: 'path',
        name: 'project_id',
        required: true,
        type: 'integer',
        description: 'ID of the current project'
      }]
    }
  }

This is what I get in the Swagger UI:

[theoomoregbee]

Can you be more explicit

[RotemBot]

The body parameters don't match the parameters I defined

[RotemBot]

How do I override/cancel the default 'body'?

[theoomoregbee]

Do you have a model for Assignment? if so check if the body matches it

[RotemBot]

Yes, of course I have a model assignment. I know it matches it, I want to override the default.

[theoomoregbee]

oh I see, the problem is body is not overriding models. Will look into it later today

[RotemBot]

Thanks!

[RotemBot]

Also, in this example, I need 'annotators' to be an array, or json object. As you can see, it is not reflected in the result. How do I do that?

[theoomoregbee]

you can use array as type https://swagger.io/docs/specification/data-models/data-types/

[RotemBot]

That doesn't work, because then you need to specify the items' type (i.e. 'string'). I've tried doing that with and without specifying items, and it did not work.

This is what happens:

Any chance you can give a full example of defining an array param through custom routes, and what it looks like in the swagger UI?

[RotemBot]

@theo4u Any update on the problem with body? And please can you give a full example of defining a string array as a param? (Not how to do it in a swagger file, but in a custom route definition).

[theoomoregbee]

going to look into this later today