Breaking Changes for REST plugin

2.0.0.0

3 May 2023

REST Multipart form data: Binary part

requestBody:
  content: 
    multipart/form-data: # Media type
      schema:            # Request payload
        type: object
        properties:      # Request parts
          myFile1:       # Part 1
            type: string
            format: binary

What breaks?

This breaking change only affects REST requests using multipart form data. Any form data containing a binary part (as Part 1 in the code section above), won't work after upgrading to this version of the plugin.

Why?

Previously binary parts of multipart form data expected a Base64 string in Linx. This upgrade corrects this and binary parts now expect binary content.

How to fix it

This can be fixed in one of two ways:

  1. Change the REST service spec to expect a Base64 part instead of a binary part in its multipart form data.
  2. Change the request to send binary content instead of a Base64 string.

Please note:

ASP.NET Core requires binary parts to have a filename specified on the request. If no filename is provided on the request, that part will be sent through as null. Multipart encoded body editor with binary part

In contrast to binary parts, Base64 parts require no filename in the request. Multipart encoded body editor with binary part