Могут ли быть поля параметров для заголовков содержимого в swagger-ui для конкретного содержимого данных формы в теле многочастного запроса в swagger-3.0? - PullRequest
0 голосов
/ 28 января 2019

Я пытаюсь создать документацию для некоторых вызовов REST API.Метод POST в одном из вызовов API принимает содержимое данных формы, состоящее из нескольких частей, причем первая часть представляет собой данные двоичного файла, а вторая часть - экземпляр json.Я ищу способ, позволяющий пользователям, имеющим доступ к пользовательскому интерфейсу swagger, вводить значение заголовка Content-Disposition и заголовка Content-Range только для 1-й части содержимого данных формы из нескольких частей.Я пытался использовать объект заголовка внутри объекта кодирования , но это не привело к каким-либо изменениям в swagger-ui.Я ожидал получить поле параметра для заголовка внутри тела запроса, как параметры заголовка запроса, заданные списком параметров.Может быть, я что-то упустил.Если это не правильный путь, есть ли другой способ, которым я могу это сделать?Заранее спасибо.

Вот часть swagger.json с телом запроса:

{
    "requestBody": {
        "content": {
            "multipart/form-data": {
                "schema": {
                    "type": "object",
                    "properties": {
                        "file": {
                            "type": "string",
                            "format": "binary"
                        },
                        "instance": {
                            "type": "object",
                            "properties": {
                                "fileName": {
                                    "type": "string"
                                },
                                "fileType": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                },
                "encoding": {
                    "file": {
                        "headers": {
                            "content-disposition": {
                                "schema": {
                                    "type": "string"
                                }
                            },
                            "content-range": {
                                 "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Ожидаемый результат: Поле параметра для каждого заголовка в теле запроса.

Фактический результат: в пользовательском интерфейсе такого поля параметров нет.

...