Export/Import 'in': 'body' param

stoplightio / api-spec-converter

This package helps to convert between different API specifications (Postman, Swagger, RAML, StopLight).

MIT License

137 stars 86 forks source link

Export/Import 'in': 'body' param #6

Closed ranacseruet closed 8 years ago

ranacseruet commented 8 years ago

Problem: swagger spec doesn't support more than one ('in':'body') param.

Implications as per discussion:

While Importing: loose the 'name' value, and set the schema directly as request body.
While Exporting: name the param as 'body', and set entire request body as schema.

ranacseruet commented 8 years ago

Just a note: I had an example test data like below:

{
       "name": "pet",
       "in": "body",
       "schema": {
          "$ref": "#/definitions/pet"
        },
       "required": false,
       "description": "The updated pet info"
}

As we discussed, besides loosing 'name' field, we are also loosing 'required' and 'description' field as well.

I hope there won't be any user, who might have built their api assuming this "in: body" param name as real api parameter(as we thought), who would loose their structure after importing the schema.