fix(oas3): get examples for oneOf and anyOf in request body

[glowcloud]

Refs #9745

[glowcloud]

The current code for getting initial values for request body and for content types application/x-www-form-urlencoded and multipart/... is there to replicate the behaviour of forms for parameters in query, header, etc.

There, if we don't have an example, we won't be generating one, unless the type of the parameter is an object. We can see this in the screenshot, where the only parameter that has an example defined in the schema is the username:

To replicate this behaviour, we only get the initial value if we have an object parameter or an example in the schema:

swagger-ui/src/core/plugins/oas3/components/request-body.jsx

Lines 176 to 181 in 3a78973

	if (type === "object" || useInitialValue) {
	// TODO: what about example or examples from requestBody could be passed as exampleOverride
	initialValue = fn.getSampleSchema(prop, false, {
	includeWriteOnly: true
	})
	}

We need an additional check for arrays with examples, as getSampleSchema would return ex. '["test"]', so we need to parse it to ["test"], here:

swagger-ui/src/core/plugins/oas3/components/request-body.jsx

Lines 186 to 188 in 3a78973

	if (typeof initialValue === "string" && type === "array") {
	initialValue = JSON.parse(initialValue)
	}

For objects, I think that this is there in case if getSampleSchema doesn't return a string for an object parameter:

swagger-ui/src/core/plugins/oas3/components/request-body.jsx

Lines 183 to 185 in 3a78973

	if (typeof initialValue !== "string" && type === "object") {
	initialValue = stringify(initialValue)
	}

If we want to move to use getSampleSchema directly, we can do it, but I think these checks for array and object would still need to be there. We would also need to add checks for anyOf and oneOf because we won't get these values for them otherwise:

swagger-ui/src/core/plugins/oas3/components/request-body.jsx

Lines 158 to 160 in 3a78973

	const type = prop.get("type")
	const format = prop.get("format")
	const description = prop.get("description")

The behaviour between the form for parameter in query etc. and for request body would be different. On the other hand, we would also align the initial value with the value we get for application/json and application/xml, and from resetting the form.

[glowcloud]

I noticed an issue with falsy values that was there before. If we have false or 0 as an example, we don't fill the integer parameter with 0 and both of the parameters will have the Send empty value option checked:

Despite that, we would send these values anyway:

[glowcloud]

We would also need to add checks for anyOf and oneOf because we won't get these values for them otherwise:

swagger-ui/src/core/plugins/oas3/components/request-body.jsx

Lines 158 to 160 in 3a78973

	const type = prop.get("type")
	const format = prop.get("format")
	const description = prop.get("description")

Only setting these values isn't enough, as we pass prop to JsonSchemaForm:

swagger-ui/src/core/plugins/oas3/components/request-body.jsx

Lines 210 to 222 in 3a78973

	<JsonSchemaForm
	fn={fn}
	dispatchInitialValue={!isFile}
	schema={prop}
	description={key}
	getComponent={getComponent}
	value={currentValue === undefined ? initialValue : currentValue}
	required = { required }
	errors = { currentErrors }
	onChange={(value) => {
	onChange(value, [key])
	}}
	/>

Example usage in JsonSchemaForm:

swagger-ui/src/core/components/json-schema-components.jsx

Lines 74 to 77 in 3a78973

	const enumValue = schema && schema.get ? schema.get("enum") : null
	const format = schema && schema.get ? schema.get("format") : null
	const type = schema && schema.get ? schema.get("type") : null
	const schemaIn = schema && schema.get ? schema.get("in") : null

It looks like we would need to set anyOf/oneOf schemas as prop anyway.

[glowcloud]

Superseded by #9762