openapi

I have a problem with Swagger UI where it displays an empty "Examples" combobox (marked yellow on the image below) which does not look good. Is there a way to remove it or change its text to something useful? I tried adding the example tag, but it won't work. The operation definition looks like this: post: tags: - pet summary: Add a new pet to the store operationId: addPet requestBody: description: Pet object that needs to be added to the store content: application/json: schema: $ref: '#/components/schemas/Pet' application/xml: schema: $ref: '#/components/schemas/Pet' required: true responses:

I am using swagger 2.0 with node.js express 4.12.3 and mysql db. I have created following schema - Country: type: "object" properties: id: type: "integer" readOnly: true description: "Country Id" country: type: "string" description: "Country name" created_at: type: "string" readOnly: true format: "date-time" description: "Country record creation date" deleted_at: type: "string" format: "date-time" description: "Country record delete date" required: - country Here deleted_at field will be null and will not be present in db until the record is deleted. My express based nodejs server returns the

Is there any spec or convention on URL where one should place swagger.json (or whatever name it is agreed) so that public API of my site can be automatically discovered? Updated 19 April 2017: The OpenAPI Wiki answer I gave previously is "for a very very very old version of the spec" . The same source states that for 2.0 the standard is swagger.json , for 3.0 it changes to openapi.json . Original answer: The OpenAPI Wiki recommends using an /api-docs endpoint, at least for server APIs. I've seen several sites in the wild that use that, and it's our shop standard. Hope that helps. How about

I'm writing an OpenAPI spec for an existing API. This API returns status 200 for both success and failure, but with a different response structure. For example, in the signup API, if the user signed up successfully, the API sends status 200 with the following JSON: { "result": true, "token": RANDOM_STRING } And if there is a duplicated user, the API also sends status 200, but with the following JSON: { "result": false, "errorCode": "00002", // this code is duplicated error "errorMsg": "duplicated account already exist" } In this case, how to define the response? This is possible in OpenAPI 3.0

looks like official swagger for openapi specification V3 support is near release https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/ , and the swagger-codegen has 3.0.0 support developed and passing some level of testing https://github.com/swagger-api/swagger-codegen on the 3.0.0 branch I have a swagger spec (generated from my existing 2.0 spec via https://github.com/mermade/swagger2openapi , output looks good) Is there an easy way to run the swagger-codegen without having to package the jar myself? this is the single result i found: https://oss.sonatype.org/content/repositories