Skip to content

Show first example value on Parameter inputs (like Header) #10776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
smiling-watermelon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Show first example value on Parameter inputs (like Header) #10776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions src/core/components/headers.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from "react"
import PropTypes from "prop-types"
import Im from "immutable"
import { getParameterExampleValue } from "core/utils/get-parameter-examples"

const propClass = "header-example"

Expand All @@ -19,7 +20,7 @@ export default class Headers extends React.Component {
if ( !headers || !headers.size )
return null

return (
return (
<div className="headers-wrapper">
<h4 className="headers__title">Headers:</h4>
<table className="headers">
Expand All @@ -31,25 +32,25 @@ export default class Headers extends React.Component {
</tr>
</thead>
<tbody>
{
headers.entrySeq().map( ([ key, header ]) => {
if(!Im.Map.isMap(header)) {
return null
}

const description = header.get("description")
const type = header.getIn(["schema"]) ? header.getIn(["schema", "type"]) : header.getIn(["type"])
const schemaExample = header.getIn(["schema", "example"])

return (<tr key={ key }>
<td className="header-col">{ key }</td>
<td className="header-col">{
!description ? null : <Markdown source={ description } />
}</td>
<td className="header-col">{ type } { schemaExample ? <Property propKey={ "Example" } propVal={ schemaExample } propClass={ propClass } /> : null }</td>
</tr>)
}).toArray()
}
{
headers.entrySeq().map( ([ key, header ]) => {
if(!Im.Map.isMap(header)) {
return null
}

const description = header.get("description")
const type = header.getIn(["schema"]) ? header.getIn(["schema", "type"]) : header.getIn(["type"])
const headerExample = getParameterExampleValue(header)

return (<tr key={ key }>
<td className="header-col">{ key }</td>
<td className="header-col">{
!description ? null : <Markdown source={ description } />
}</td>
<td className="header-col">{ type } { headerExample !== undefined ? <Property propKey={ "Example" } propVal={ headerExample } propClass={ propClass } /> : null }</td>
</tr>)
}).toArray()
}
</tbody>
</table>
</div>
Expand Down
129 changes: 76 additions & 53 deletions src/core/components/parameter-row.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ import PropTypes from "prop-types"
import ImPropTypes from "react-immutable-proptypes"
import win from "core/window"
import { getExtensions, getCommonExtensions, numberToString, stringify, isEmptyValue } from "core/utils"
import {
getParameterExample,
getParameterExampleValue,
getParameterExamples,
} from "core/utils/get-parameter-examples"
import getParameterSchema from "core/utils/get-parameter-schema.js"

export default class ParameterRow extends Component {
Expand Down Expand Up @@ -102,6 +107,14 @@ export default class ParameterRow extends Component {
.get("content", Map())
.keySeq()
.first()
const currentExampleKey = oas3Selectors.activeExamplesMember(
...pathMethod,
"parameters",
this.getParamKey()
)
const parameterExamples = getParameterExamples(paramWithMeta, {
parameterMediaType,
})

// getSampleSchema could return null
const generatedSampleValue = schema ? fn.getSampleSchema(schema.toJS(), parameterMediaType, {
Expand All @@ -121,26 +134,25 @@ export default class ParameterRow extends Component {
if (specSelectors.isSwagger2()) {
initialValue =
paramWithMeta.get("x-example") !== undefined
? paramWithMeta.get("x-example")
: paramWithMeta.getIn(["schema", "example"]) !== undefined
? paramWithMeta.getIn(["schema", "example"])
: (schema && schema.getIn(["default"]))
? paramWithMeta.get("x-example")
: paramWithMeta.getIn(["schema", "example"]) !== undefined
? paramWithMeta.getIn(["schema", "example"])
: (schema && schema.getIn(["default"]))
} else if (specSelectors.isOAS3()) {
schema = this.composeJsonSchema(schema)

const currentExampleKey = oas3Selectors.activeExamplesMember(...pathMethod, "parameters", this.getParamKey())
initialValue =
paramWithMeta.getIn(["examples", currentExampleKey, "value"]) !== undefined
? paramWithMeta.getIn(["examples", currentExampleKey, "value"])
: paramWithMeta.getIn(["content", parameterMediaType, "example"]) !== undefined
? paramWithMeta.getIn(["content", parameterMediaType, "example"])
: paramWithMeta.get("example") !== undefined
? paramWithMeta.get("example")
: (schema && schema.get("example")) !== undefined
? (schema && schema.get("example"))
: (schema && schema.get("default")) !== undefined
? (schema && schema.get("default"))
: paramWithMeta.get("default") // ensures support for `parameterMacro`
getParameterExampleValue(paramWithMeta, {
parameterMediaType,
activeExampleKey: currentExampleKey,
}) !== undefined
? getParameterExampleValue(paramWithMeta, {
parameterMediaType,
activeExampleKey: currentExampleKey,
})
: (schema && schema.get("default")) !== undefined
? (schema && schema.get("default"))
: paramWithMeta.get("default") // ensures support for `parameterMacro`
}

//// Process the initial value
Expand All @@ -160,7 +172,7 @@ export default class ParameterRow extends Component {
} else if(
schemaObjectType === "object"
&& generatedSampleValue
&& !paramWithMeta.get("examples")
&& !parameterExamples
) {
// Object parameters get special treatment.. if the user doesn't set any
// default or example values, we'll provide initial values generated from
Expand All @@ -179,7 +191,7 @@ export default class ParameterRow extends Component {
schemaObjectType === "array"
&& schemaItemsType === "object"
&& generatedSampleValue
&& !paramWithMeta.get("examples")
&& !parameterExamples
) {
this.onChangeWrapper(
List.isList(generatedSampleValue) ? (
Expand Down Expand Up @@ -226,16 +238,16 @@ export default class ParameterRow extends Component {
let inType = param.get("in")
let bodyParam = inType !== "body" ? null
: <ParamBody getComponent={getComponent}
getConfigs={ getConfigs }
fn={fn}
param={param}
consumes={ specSelectors.consumesOptionsFor(pathMethod) }
consumesValue={ specSelectors.contentTypeValues(pathMethod).get("requestContentType") }
onChange={this.onChangeWrapper}
onChangeConsumes={onChangeConsumes}
isExecute={ isExecute }
specSelectors={ specSelectors }
pathMethod={ pathMethod }
getConfigs={ getConfigs }
fn={fn}
param={param}
consumes={ specSelectors.consumesOptionsFor(pathMethod) }
consumesValue={ specSelectors.contentTypeValues(pathMethod).get("requestContentType") }
onChange={this.onChangeWrapper}
onChangeConsumes={onChangeConsumes}
isExecute={ isExecute }
specSelectors={ specSelectors }
pathMethod={ pathMethod }
/>

const ModelExample = getComponent("modelExample")
Expand All @@ -251,6 +263,12 @@ export default class ParameterRow extends Component {
.get("content", Map())
.keySeq()
.first()
const currentExampleKey = isOAS3
? oas3Selectors.activeExamplesMember(...pathMethod, "parameters", this.getParamKey())
: undefined
const parameterExamples = isOAS3
? getParameterExamples(param, { parameterMediaType })
: undefined

if (isOAS3) {
schema = this.composeJsonSchema(schema)
Expand Down Expand Up @@ -300,7 +318,12 @@ export default class ParameterRow extends Component {
if (paramDefaultValue === undefined) {
paramDefaultValue = param.get("default")
}
paramExample = param.get("example")
paramExample = isOAS3
? getParameterExampleValue(param, {
parameterMediaType,
activeExampleKey: currentExampleKey,
})
: param.get("example")
if (paramExample === undefined) {
paramExample = param.get("x-example")
}
Expand Down Expand Up @@ -340,9 +363,9 @@ export default class ParameterRow extends Component {

{ (bodyParam || !isExecute) && isDisplayParamEnum ?
<Markdown className="parameter__enum" source={
"<i>Available values</i> : " + paramEnum.map(function(item) {
return item
}).toArray().map(String).join(", ")}/>
"<i>Available values</i> : " + paramEnum.map(function(item) {
return item
}).toArray().map(String).join(", ")}/>
: null
}

Expand All @@ -359,15 +382,15 @@ export default class ParameterRow extends Component {
{(isFormData && !isFormDataSupported) && <div>Error: your browser does not support FormData</div>}

{
isOAS3 && param.get("examples") ? (
isOAS3 && parameterExamples ? (
<section className="parameter-controls">
<ExamplesSelectValueRetainer
examples={param.get("examples")}
examples={parameterExamples}
onSelect={this._onExampleSelect}
updateValue={this.onChangeWrapper}
getComponent={getComponent}
defaultToFirstExample={true}
currentKey={oas3Selectors.activeExamplesMember(...pathMethod, "parameters", this.getParamKey())}
currentKey={currentExampleKey}
currentUserInputValue={value}
/>
</section>
Expand All @@ -388,37 +411,37 @@ export default class ParameterRow extends Component {
schema={schema}
example={jsonSchemaForm}
/>
) : jsonSchemaForm
) : jsonSchemaForm
}

{
bodyParam && schema ? <ModelExample getComponent={ getComponent }
specPath={specPath.push("schema")}
getConfigs={ getConfigs }
isExecute={ isExecute }
specSelectors={ specSelectors }
schema={ schema }
example={ bodyParam }
includeWriteOnly={ true }/>
specPath={specPath.push("schema")}
getConfigs={ getConfigs }
isExecute={ isExecute }
specSelectors={ specSelectors }
schema={ schema }
example={ bodyParam }
includeWriteOnly={ true }/>
: null
}

{
!bodyParam && isExecute && param.get("allowEmptyValue") ?
<ParameterIncludeEmpty
onChange={this.onChangeIncludeEmpty}
isIncluded={specSelectors.parameterInclusionSettingFor(pathMethod, param.get("name"), param.get("in"))}
isDisabled={!isEmptyValue(value)} />
: null
<ParameterIncludeEmpty
onChange={this.onChangeIncludeEmpty}
isIncluded={specSelectors.parameterInclusionSettingFor(pathMethod, param.get("name"), param.get("in"))}
isDisabled={!isEmptyValue(value)} />
: null
}

{
isOAS3 && param.get("examples") ? (
isOAS3 && parameterExamples ? (
<Example
example={param.getIn([
"examples",
oas3Selectors.activeExamplesMember(...pathMethod, "parameters", this.getParamKey())
])}
example={getParameterExample(param, {
parameterMediaType,
activeExampleKey: currentExampleKey,
})}
getComponent={getComponent}
getConfigs={getConfigs}
/>
Expand Down
Loading