kenspirit/joi-route-to-swagger

Convert joi route definition to swagger doc json format

joi-route-to-swagger's Issues

Problem with optional params

Hi, guys,
I have the problems with the mapping Joi shemas to Swagger UI and I look for your advices :)

1. Problem with the optional param
   As you can see below we have optional param "id".
   In case of request body - this parameter shouldn't be visible, because this "id" will be created under the hood.
   In case of response body - this parameter should be visible, because "id" was created at this time.
   I use this common schema both for request and response body:

export const BotSchema = Joi.object().keys({
    id: Joi.string().optional(),
    layout: Joi.number().required().label('bot.navigation.$.layout'),
    title: Joi.string().required().label('bot.navigation.$.title'),
    type: Joi.string().required(),
});

As a result - we can see "id" param in both cases - req and res:

What is a right way to working with this schemas?
Should I create different schemas - first for request body and second for response body?

2. Problem with the incorrect display of the parameters.
   As you can see below I use the next schema for displaying request body:
   

I see the next picture, but It's incorrect result (we have different types of field "data" depends on field "type".

What is a right way to configure this schemas for displaying correct result in Swagger UI?

Thanks in advance!

Can't upload the file via swagger

Hello sir,

Can anyway to upload the multipart/form-data via joi_to_json_schema?

Unable to render this definition

Hello sir,

Can you help me out!!

Unable to render this definition
The provided definition does not specify a valid version field.

Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.0.n (for example, openapi: 3.0.0).

https://picresize.com/popup.html?images/rsz_screenshot_from_2020-11-10_10-44-24.png

joi.when() is not working

For joi.when() schema proper swagger definition is not coming for example

Joi schema:-
myRequiredField: rm.joi.boolean(),
message: rm.joi.when('myRequiredField', {
is: true,
then: rm.joi.string(),
otherwise: rm.joi.number(),
})

Actual swagger definition:-
"myRequiredField": {
"type": "boolean",
"description": ""
},
"message": {
"type": [
"array",
"boolean",
"number",
"object",
"string",
"null"
],
"description": ""
}

Expected swagger definition:-

"myRequiredField": {
"type": "boolean",
"description": ""
},
"message": {
"properties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number",
"format": "number"
}
]
}
}

No header token is passed in open api 3.0.1

I try to pass the auth token but it does not allow to send in the request headers

Incorrect reference to entities

Hello,

The current version generates an incorrect reference in the entity defintion.

pet: {
   type: "object",
   description: "",
   schema: {
      $ref: "#/definitions/Pet"
   }
},

The correct version should be:

pet: {
   type: "object",
   description: "",
   $ref: "#/definitions/Pet"
},

How to define upload api

Is there any example to define an upload api?

how can i get custom response

how can i get custom response and remove schemas from documentation