Swagger OpenAPI describing string array in multipart requestt

Question

I need to describe a multipart query that has an array of strings. But I ran into a problem, in the query, the array elements are combined into one string instead of being separate string items. I am using OpenApi 3.0.3)

requestBody: {
          content: {
            'multipart/form-data': {
              schema: {
                type: 'object',
                properties: {
                  email: {
                    type: 'string',
                  },
                  password: {
                    type: 'string',
                  },
                  confirmPassword: {
                    type: 'string',
                  },
                  fullName: {
                    type: 'string',
                  },
                  avatar: {
                    type: 'string',
                    format: 'binary',
                  },
                  'genreIds[]': {
                    type: 'array',
                    items: {
                      oneOf: {
                        type: 'string',
                      },
                    },
                  },
                  'languageIds[]': {
                    type: 'array',
                    items: {
                      type: 'string',
                      default: '',
                    },
                  },
                },
              },
            },
          },
        },

What I received: genreIds: [ '1234,55466,2455' ] What I expect: genreIds: [ '1234','55466','2455' ]

Does this answer your question? Swagger OpenAPI describing string array in multipart request — chv
– chv, Commented Jan 14, 2024 at 15:50

teodor96 · Accepted Answer · 2024-04-15 09:42:08Z

0

Try adding style: 'form' and explode: true for parameters of type: 'array':

  'genreIds[]': {
    type: 'array',
    items: {
      oneOf: {
        type: 'string',
      },
    },
    style: 'form',
    explode: true
  }

For more details please read the OpenAPI 3.0.3 documentation.

edited Apr 15, 2024 at 9:42

answered Apr 15, 2024 at 9:40

teodor96

33 bronze badges

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

Collectives™ on Stack Overflow

Swagger OpenAPI describing string array in multipart requestt

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related