Parameter description doesn't take into account enum inside schema

[alexeyr-ci]

In OpenAPI/Swagger 2.0, enum parameters are described using

        - in: query
          name: sort
          description: Sort order
          type: string
          enum: [asc, desc]

In 3.0, it should be

        - in: query
          name: sort
          description: Sort order
          schema:
            type: string
            enum: [asc, desc]

and the 2.0 style description fails to validate.

But the converter only supports the first option:

openapi-to-postman/lib/schemaUtils.js

Lines 478 to 484 in 34f299e

	getParameterDescription: function(parameter) {
	if (!_.isObject(parameter)) {
	return '';
	}
	return (parameter.required ? '(Required) ' : '') + (parameter.description || '') +
	(parameter.enum ? ' (This can only be one of ' + parameter.enum + ')' : '');
	},

I believe this changes should fix it:

    const enum = parameter.enum ?? parameter.schema?.enum;
    return (parameter.required ? '(Required) ' : '') + (parameter.description || '') +
      (enum ? ' (This can only be one of ' + enum + ')' : '');

There's also a more minor issue that if the parameter description is empty, but the other two parts aren't, there are two spaces between (Required) and (This can only be...).

When debugging, I see lib/schemaUtils.js being hit, and not the equivalent in libV2/schemaUtils.js

openapi-to-postman/libV2/schemaUtils.js

Lines 911 to 918 in 34f299e

	getParameterDescription = (parameter) => {
	if (!_.isObject(parameter)) {
	return '';
	}
	return (parameter.required ? '(Required) ' : '') + (parameter.description || '') +
	(parameter.enum ? ' (This can only be one of ' + parameter.enum + ')' : '');
	},

I don't know why, but maybe that needs to be updated similarly.

[sahalbelam]

enum can only be used in typescript right???

[alexeyr-ci]

@sahalbelam No, why? It just means that a request/response passing something else is invalid, the language used in the OpenAPI client/server doesn't matter.

[Yashkrit-Singh]

hey @alexeyr-ci, i am new to contribution and excited about solving the issues. Can you please assign me this issue ?

[alexeyr-ci]

@Yashkrit-Singh I can't, I'm not on the team, I just reported the issue.