By default, fields in a model are optional unless you put them in the required list. Below is an example – id, category are optional fields, name is required. Note that required is not an attribute of fields, but an attribute of the object itself – it’s a list of required properties. type: object required: … Read more
You’re getting the error in the model, because that’s not the way to define required properties. The correct form would be: “my_response_object”: { “type”: “object”, “required”: [ “result” ], “properties”: { “result”: { “type”: “string”, “description”: “value of ‘success’ or ‘error’, indicated whether was successful” }, “message”: { “type”: “string”, “description”: “an error message if … Read more
From the OpenAPI Generator FAQs What is the difference between Swagger Codegen and OpenAPI Generator? Swagger Codegen is driven by SmartBear while OpenAPI Generator is driven by the community. More than 40 top contributors and template creators of Swagger Codegen have joined OpenAPI Generator as the founding team members. For more details, see the Fork … Read more
For anyone that runs into this problem; After a day of troubleshooting and the Swagger support guys pointing me in the right direction, it turns out that this is currently caused by a bug within the AWS API Gateway custom authorizers. We are currently using AWS API Gateway for managing our APIs, this includes managing … Read more
Mutually exclusive parameters are possible (sort of) in OpenAPI 3.x: Define the mutually exclusive parameters as object properties, and use oneOf or maxProperties to limit the object to just 1 property. Use the parameter serialization method style: form and explode: true, so that the object is serialized as ?propName=value. An example using the minProperties and … Read more
I made it work with: post: consumes: – application/json produces: – application/json – text/xml – text/html parameters: – name: body in: body required: true schema: # Body schema with atomic property examples type: object properties: testapi: type: object properties: messageId: type: string example: kkkk8 messageDateTime: type: string example: ‘2014-08-17T14:07:30+0530’ testapiBody: type: object properties: cameraServiceRq: type: … Read more
Update The issue detailed below is now resolved in Swashbuckle v5.5.0. Issue Just ran into the exact same issue. I think the root cause is this line in Swashbuckle’s source code: var key = encodeURIComponent($(‘#input_apiKey’)[0].value); This is where the value from the HTML input field goes through URL encoding turning the space into %20. I’m … Read more
Swagger is a notation/rules to write documentation. But why is it called a framework(Like angular/MVC)? It is probably called a “framework” because its’ purpose is to offer a systematic way of notating the interface of any RESTful service under the OpenAPI Specification. This is a big deal to developers because the spec is overseen by … Read more
The error message is misleading. The actual error is that your path parameter is missing required: true. Path parameters are always required, so remember to add required: true to them.
The required keyword in OpenAPI Schema Objects is taken from JSON Schema and means: An object instance is valid against this keyword if every item in the [required] array is the name of a property in the instance. In other words, required means “property must be present”, regardless of its value. The type, format, etc. … Read more